Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump version to v1.0.0 & add release notes #96

Merged
merged 2 commits into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions VERSION
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
VERSION_MAJOR 0
VERSION_MINOR 4
VERSION_MAJOR 1
VERSION_MINOR 0
VERSION_PATCH 0
2 changes: 1 addition & 1 deletion docs/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>fastddsspy_docs</name>
<version>0.4.0</version>
<version>1.0.0</version>
<description>
*eprosima Fast DDS Spy* Documentation built with sphinx and deployed in ReadTheDocs.
</description>
Expand Down
2 changes: 1 addition & 1 deletion docs/rst/installation/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The steps to run |spy| in a Docker container are explained below.
--ipc=host \
--privileged \
-v /<fastddsspy>/FASTDDSSPY_CONFIGURATION.yaml:/root/FASTDDSSPY_CONFIGURATION.yaml \
ubuntu-fastddsspy:v0.4.0
ubuntu-fastddsspy:v1.0.0
It is important to mention that both the path to the configuration file hosted in the local machine and the one
created in the Docker container must be absolute paths in order to share just one single file as a shared volume.
Expand Down
11 changes: 1 addition & 10 deletions docs/rst/notes/forthcoming_version.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,8 @@

.. add orphan tag when new info added to this file

.. :orphan:
:orphan:

###################
Forthcoming Version
###################

This release includes the following **CI improvements**:

* Upgrade to Ubuntu Noble (24.04).
* Remove Ubuntu Focal (20.04) from the CI.

This release includes the following **Configuration Features**:

* New :ref:`domain argument <user_manual_user_interface_domain_argument>` to configure the ``domain`` through the command-line.
27 changes: 18 additions & 9 deletions docs/rst/notes/notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,27 @@

.. _notes:

.. include:: forthcoming_version.rst
.. .. include:: forthcoming_version.rst

##############
Version v0.4.0
Version v1.0.0
##############

This release includes the following **Features**:

* Add support for Fast DDS v3.

This release includes the following **Configuration Features**:

* New configuration option ``logging`` to configure the :ref:`Logs <spy_specs_logging>`.
* New :ref:`domain argument <user_manual_user_interface_domain_argument>` to configure the ``domain`` through the command-line.
* Change default log filter to ``FASTDDSSPY``.
* Change default log verbosity to ``error``.

This release includes the following **Documentation Updates**:
This release includes the following **CI improvements**:

* Add a new :ref:`Logging <spy_specs_logging>` section to the :ref:`Configuration <user_manual_configuration>` page.
* Upgrade to Ubuntu Noble (24.04).
* Remove Ubuntu Focal (20.04) from the CI.
* Empty XTSAN tests list to run all tests with Thread Sanitizer.

This release includes the following **Dependencies Update**:

Expand All @@ -31,26 +39,27 @@ This release includes the following **Dependencies Update**:
- `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`_
* - Fast CDR
- `eProsima/Fast-CDR <https://github.com/eProsima/Fast-CDR>`_
- `v2.1.3 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.1.3>`_
- `v2.2.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.0>`_
- `v2.2.4 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.4>`_
* - Fast DDS
- `eProsima/Fast-DDS <https://github.com/eProsima/Fast-DDS>`_
- `v2.13.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.13.1>`_
- `v2.14.0 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.14.0>`_
- `v3.0.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v3.0.1>`_
* - Dev Utils
- `eProsima/dev-utils <https://github.com/eProsima/dev-utils>`_
- `v0.5.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.5.0>`_
- `v0.6.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.6.0>`_
- `v1.0.0 <https://github.com/eProsima/dev-utils/releases/tag/v1.0.0>`_
* - DDS Pipe
- `eProsima/DDS-Pipe <https://github.com/eProsima/DDS-Pipe.git>`_
- `v0.3.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.3.0>`_
- `v0.4.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.4.0>`_
- `v1.0.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.4.0>`_


#################
Previous Versions
#################

.. include:: ./previous_versions/v0.4.0.rst
.. include:: ./previous_versions/v0.3.0.rst
.. include:: ./previous_versions/v0.2.0.rst
.. include:: ./previous_versions/v0.1.0.rst
40 changes: 40 additions & 0 deletions docs/rst/notes/previous_versions/v0.4.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Version v0.4.0
==============

This release includes the following **Configuration Features**:

* New configuration option ``logging`` to configure the :ref:`Logs <spy_specs_logging>`.

This release includes the following **Documentation Updates**:

* Add a new :ref:`Logging <spy_specs_logging>` section to the :ref:`Configuration <user_manual_configuration>` page.

This release includes the following **Dependencies Update**:

.. list-table::
:header-rows: 1

* -
- Repository
- Old Version
- New Version
* - Foonathan Memory Vendor
- `eProsima/foonathan_memory_vendor <https://github.com/eProsima/foonathan_memory_vendor>`_
- `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`_
- `v1.3.1 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.1>`_
* - Fast CDR
- `eProsima/Fast-CDR <https://github.com/eProsima/Fast-CDR>`_
- `v2.1.3 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.1.3>`_
- `v2.2.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.0>`_
* - Fast DDS
- `eProsima/Fast-DDS <https://github.com/eProsima/Fast-DDS>`_
- `v2.13.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.13.1>`_
- `v2.14.0 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.14.0>`_
* - Dev Utils
- `eProsima/dev-utils <https://github.com/eProsima/dev-utils>`_
- `v0.5.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.5.0>`_
- `v0.6.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.6.0>`_
* - DDS Pipe
- `eProsima/DDS-Pipe <https://github.com/eProsima/DDS-Pipe.git>`_
- `v0.3.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.3.0>`_
- `v0.4.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.4.0>`_
2 changes: 1 addition & 1 deletion fastddsspy_participants/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>fastddsspy_participants</name>
<version>0.4.0</version>
<version>1.0.0</version>
<description>
*eProsima Fast DDS Spy* core logic.
</description>
Expand Down
2 changes: 1 addition & 1 deletion fastddsspy_tool/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>fastddsspy_tool</name>
<version>0.4.0</version>
<version>1.0.0</version>
<description>
*eProsima Fast DDS Spy* Application to execute a interactive CLI spy application to introspect data in a DDS network.
</description>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def __init__(self):
arguments_dds=[],
arguments_spy=['--version'],
commands_spy=[],
output="""Fast DDS Spy v0.4.0\
output="""Fast DDS Spy v1.0.0\
commit hash: 16ed7e8c93d7481d8b426746af9ec3ffa323f451\n"""
)

Expand Down
2 changes: 1 addition & 1 deletion fastddsspy_yaml/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>fastddsspy_yaml</name>
<version>0.4.0</version>
<version>1.0.0</version>
<description>
*eprosima Fast DDS Spy* Yaml Module to read and print yaml objects.
</description>
Expand Down
Loading