Skip to content

Commit

Permalink
Release v0.4.0: Update Release notes (#77)
Browse files Browse the repository at this point in the history
* Update Release notes

Signed-off-by: cferreiragonz <[email protected]>

* Suggestions

Signed-off-by: cferreiragonz <[email protected]>

---------

Signed-off-by: cferreiragonz <[email protected]>
  • Loading branch information
cferreiragonz authored Mar 25, 2024
1 parent 6f6d019 commit 0f68659
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 28 deletions.
6 changes: 1 addition & 5 deletions docs/rst/notes/forthcoming_version.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@

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

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

This release will include the following **Configuration features**:

* New configuration option ``logging`` to configure the :ref:`Logs <spy_specs_logging>`.
32 changes: 9 additions & 23 deletions docs/rst/notes/notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,19 @@

.. _notes:

.. include:: forthcoming_version.rst
.. .. include:: forthcoming_version.rst
##############
Version v0.3.0
Version v0.4.0
##############

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

* Display data type information in either ROS 2 format (MSG) or DDS format (IDL).
* :ref:`Topic configuration <user_manual_configuration_dds__manual_topics>`.
* :ref:`Max Reception Rate <user_manual_configuration_dds__max_rx_rate>` per topic.
* :ref:`Downsampling <user_manual_configuration_dds__downsampling>` per topic.
* Remove the support for built-in Topics.

This release includes the following **Internal Changes** and **Bugfixes**:

* Support both fastcdr v1 and v2.
* Add support for Fast DDS versions lower than v2.13.
* Set `app_id` and `app_metadata` attributes in *eProsima Fast DDS Spy* participants.
* Add participant and endpoint info topics to allowlist.
* Add internal builtin topics as DDS Topics.
* Reload internal topics when reloading the configuration file.
* Process an empty YAML when a configuration file isn't provided.
* New configuration option ``logging`` to configure the :ref:`Logs <spy_specs_logging>`.

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

* Update next steps in main example and remove warning in docker installation.
* Fix documentation build for Sphinx versions lower than 5.0.
* Add a new :ref:`<spy_specs_logging>` section to the :ref:`<user_manual_configuration>` page.

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

Expand All @@ -46,25 +31,26 @@ 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>`_
- `v1.1.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.1.0>`_
- `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.11.0 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.11.0>`_
- `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.4.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.4.0>`_
- `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.2.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.2.0>`_
- `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>`_


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

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

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

* Display data type information in either ROS 2 format (MSG) or DDS format (IDL).
* :ref:`Topic configuration <user_manual_configuration_dds__manual_topics>`.
* :ref:`Max Reception Rate <user_manual_configuration_dds__max_rx_rate>` per topic.
* :ref:`Downsampling <user_manual_configuration_dds__downsampling>` per topic.
* Remove the support for built-in Topics.

This release includes the following **Internal Changes** and **Bugfixes**:

* Support both fastcdr v1 and v2.
* Add support for Fast DDS versions lower than v2.13.
* Set `app_id` and `app_metadata` attributes in *eProsima Fast DDS Spy* participants.
* Add participant and endpoint info topics to allowlist.
* Add internal builtin topics as DDS Topics.
* Reload internal topics when reloading the configuration file.
* Process an empty YAML when a configuration file isn't provided.

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

* Update next steps in main example and remove warning in docker installation.
* Fix documentation build for Sphinx versions lower than 5.0.

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>`_
- `v1.1.0 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.1.0>`_
- `v2.1.3 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.1.3>`_
* - Fast DDS
- `eProsima/Fast-DDS <https://github.com/eProsima/Fast-DDS>`_
- `v2.11.0 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.11.0>`_
- `v2.13.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.13.1>`_
* - Dev Utils
- `eProsima/dev-utils <https://github.com/eProsima/dev-utils>`_
- `v0.4.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.4.0>`_
- `v0.5.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.5.0>`_
* - DDS Pipe
- `eProsima/DDS-Pipe <https://github.com/eProsima/DDS-Pipe.git>`_
- `v0.2.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.2.0>`_
- `v0.3.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.3.0>`_

0 comments on commit 0f68659

Please sign in to comment.