From 6d77cb1572dbb85c6a2b45484962e9699a46311f Mon Sep 17 00:00:00 2001 From: Irene Bandera Moreno Date: Mon, 16 Sep 2024 17:29:06 +0200 Subject: [PATCH] Bump version to v1.0.0 & add release notes (#96) * Add v1.0.0 release notes Signed-off-by: Irene Bandera * Bump version to v1.0.0 Signed-off-by: Irene Bandera --------- Signed-off-by: Irene Bandera --- VERSION | 4 +- docs/package.xml | 2 +- docs/rst/installation/docker.rst | 2 +- docs/rst/notes/forthcoming_version.rst | 11 +---- docs/rst/notes/notes.rst | 27 ++++++++----- docs/rst/notes/previous_versions/v0.4.0.rst | 40 +++++++++++++++++++ fastddsspy_participants/package.xml | 2 +- fastddsspy_tool/package.xml | 2 +- .../test_cases/one_shot__version.py | 2 +- fastddsspy_yaml/package.xml | 2 +- 10 files changed, 67 insertions(+), 27 deletions(-) create mode 100644 docs/rst/notes/previous_versions/v0.4.0.rst diff --git a/VERSION b/VERSION index 78647b45..8c5090ac 100644 --- a/VERSION +++ b/VERSION @@ -1,3 +1,3 @@ -VERSION_MAJOR 0 -VERSION_MINOR 4 +VERSION_MAJOR 1 +VERSION_MINOR 0 VERSION_PATCH 0 diff --git a/docs/package.xml b/docs/package.xml index a747e1e5..f3b2d5e7 100644 --- a/docs/package.xml +++ b/docs/package.xml @@ -2,7 +2,7 @@ fastddsspy_docs - 0.4.0 + 1.0.0 *eprosima Fast DDS Spy* Documentation built with sphinx and deployed in ReadTheDocs. diff --git a/docs/rst/installation/docker.rst b/docs/rst/installation/docker.rst index bb7fbe08..9fa30bc1 100644 --- a/docs/rst/installation/docker.rst +++ b/docs/rst/installation/docker.rst @@ -48,7 +48,7 @@ The steps to run |spy| in a Docker container are explained below. --ipc=host \ --privileged \ -v //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. diff --git a/docs/rst/notes/forthcoming_version.rst b/docs/rst/notes/forthcoming_version.rst index 36dced7e..5cd65f07 100644 --- a/docs/rst/notes/forthcoming_version.rst +++ b/docs/rst/notes/forthcoming_version.rst @@ -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 ` to configure the ``domain`` through the command-line. diff --git a/docs/rst/notes/notes.rst b/docs/rst/notes/notes.rst index e09a768c..b3b3970d 100644 --- a/docs/rst/notes/notes.rst +++ b/docs/rst/notes/notes.rst @@ -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 `. +* New :ref:`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 ` section to the :ref:`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**: @@ -31,26 +39,27 @@ This release includes the following **Dependencies Update**: - `v1.3.1 `_ * - Fast CDR - `eProsima/Fast-CDR `_ - - `v2.1.3 `_ - `v2.2.0 `_ + - `v2.2.4 `_ * - Fast DDS - `eProsima/Fast-DDS `_ - - `v2.13.1 `_ - `v2.14.0 `_ + - `v3.0.1 `_ * - Dev Utils - `eProsima/dev-utils `_ - - `v0.5.0 `_ - `v0.6.0 `_ + - `v1.0.0 `_ * - DDS Pipe - `eProsima/DDS-Pipe `_ - - `v0.3.0 `_ - `v0.4.0 `_ + - `v1.0.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 diff --git a/docs/rst/notes/previous_versions/v0.4.0.rst b/docs/rst/notes/previous_versions/v0.4.0.rst new file mode 100644 index 00000000..aa9b4320 --- /dev/null +++ b/docs/rst/notes/previous_versions/v0.4.0.rst @@ -0,0 +1,40 @@ +Version v0.4.0 +============== + +This release includes the following **Configuration Features**: + +* New configuration option ``logging`` to configure the :ref:`Logs `. + +This release includes the following **Documentation Updates**: + +* Add a new :ref:`Logging ` section to the :ref:`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 `_ + - `v1.3.1 `_ + - `v1.3.1 `_ + * - Fast CDR + - `eProsima/Fast-CDR `_ + - `v2.1.3 `_ + - `v2.2.0 `_ + * - Fast DDS + - `eProsima/Fast-DDS `_ + - `v2.13.1 `_ + - `v2.14.0 `_ + * - Dev Utils + - `eProsima/dev-utils `_ + - `v0.5.0 `_ + - `v0.6.0 `_ + * - DDS Pipe + - `eProsima/DDS-Pipe `_ + - `v0.3.0 `_ + - `v0.4.0 `_ diff --git a/fastddsspy_participants/package.xml b/fastddsspy_participants/package.xml index 7c296439..8eb67898 100644 --- a/fastddsspy_participants/package.xml +++ b/fastddsspy_participants/package.xml @@ -2,7 +2,7 @@ fastddsspy_participants - 0.4.0 + 1.0.0 *eProsima Fast DDS Spy* core logic. diff --git a/fastddsspy_tool/package.xml b/fastddsspy_tool/package.xml index 09f7d3d0..c7f3ff7f 100644 --- a/fastddsspy_tool/package.xml +++ b/fastddsspy_tool/package.xml @@ -2,7 +2,7 @@ fastddsspy_tool - 0.4.0 + 1.0.0 *eProsima Fast DDS Spy* Application to execute a interactive CLI spy application to introspect data in a DDS network. diff --git a/fastddsspy_tool/test/application/test_cases/one_shot__version.py b/fastddsspy_tool/test/application/test_cases/one_shot__version.py index dd23e9b6..08a798ae 100644 --- a/fastddsspy_tool/test/application/test_cases/one_shot__version.py +++ b/fastddsspy_tool/test/application/test_cases/one_shot__version.py @@ -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""" ) diff --git a/fastddsspy_yaml/package.xml b/fastddsspy_yaml/package.xml index 4576b20a..5d108a8e 100644 --- a/fastddsspy_yaml/package.xml +++ b/fastddsspy_yaml/package.xml @@ -2,7 +2,7 @@ fastddsspy_yaml - 0.4.0 + 1.0.0 *eprosima Fast DDS Spy* Yaml Module to read and print yaml objects.