Skip to content

Commit

Permalink
Release v0.3.0: Update release notes in docs (#65)
Browse files Browse the repository at this point in the history 
* Update release notes in docs

Signed-off-by: Lucia Echevarria <[email protected]>

* Complete release notes and add table of dependencies

Signed-off-by: Raul Sanchez-Mateos <[email protected]>

---------

Signed-off-by: Lucia Echevarria <[email protected]>
Signed-off-by: Raul Sanchez-Mateos <[email protected]>
Co-authored-by: Raul Sanchez-Mateos <[email protected]>
  • Loading branch information
@LuciaEchevarria99 @rsanchez15
LuciaEchevarria99 and rsanchez15 authored Jan 25, 2024
1 parent 20491d9 commit 3c36e7b
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 33 deletions.
9 changes: 0 additions & 9 deletions docs/rst/notes/forthcoming_version.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,3 @@
###################
Forthcoming Version
###################

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

* Display information in either ROS 2 format or the raw DDS format.
* :ref:`Manual Topics <user_manual_configuration_dds__manual_topics>`.
* :ref:`Max Reception Rate <user_manual_configuration_dds__max_rx_rate>`.
* :ref:`Downsampling <user_manual_configuration_dds__downsampling>`.
* Remove the support for Built-in Topics.
* Set `app_id` and `app_metadata` attributes in *eProsima Fast DDS Spy* participants.
49 changes: 25 additions & 24 deletions docs/rst/notes/notes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,33 @@
.. _notes:

.. TODO uncomment when there are forthcoming notes
.. include:: forthcoming_version.rst
.. .. include:: forthcoming_version.rst
##############
Version v0.2.0
Version v0.3.0
##############

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

* Support :ref:`Interface Whitelisting <user_manual_configuration_dds__interface_whitelist>`.
* Support :ref:`Custom Transport Descriptors <user_manual_configuration_dds_custom_transport_descriptors>` (UDP or Shared Memory only).
* Support :ref:`Ignore Participant Flags <user_manual_configuration_dds_ignore_participant_flags>`.

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

* Print only active participants when using verbose mode in ``participants`` command.
* Fix C++ *namespace* ambiguities in yaml configuration.
* Change default log-filter to only show warning coming from DDS Spy source code.
* Filter out topics associated to services (RPC).
* Parameterize simulated endpoints.
* 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.
* Set `app_id` and `app_metadata` attributes in *eProsima Fast DDS Spy* participants.
* Make the trigger of the DDS Pipe callbacks configurable.
* Support both fastcdr v1 and v2.
* Add support for Fast DDS versions lower than v2.13.

This release includes the following **Bugfixes**:
* 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 introduction section in README file.

This release includes the following change in the **Continuous Integration** process:

* Update CI to use `eProsima CI <https://github.com/eProsima/eProsima-CI>`__.
* 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**:

Expand All @@ -42,28 +42,29 @@ This release includes the following **Dependencies Update**:
- New Version
* - Foonathan Memory Vendor
- `eProsima/foonathan_memory_vendor <https://github.com/eProsima/foonathan_memory_vendor>`_
- `v1.3.0 <https://github.com/eProsima/foonathan_memory_vendor/releases/tag/v1.3.0>`_
- `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.0.27 <https://github.com/eProsima/Fast-CDR/releases/tag/v1.0.27>`_
- `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.10.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v2.10.1>`_
- `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.3.0 <https://github.com/eProsima/dev-utils/releases/tag/v0.3.0>`_
- `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.1.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/v0.1.0>`_
- `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>`_


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

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

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

* Support :ref:`Interface Whitelisting <user_manual_configuration_dds__interface_whitelist>`.
* Support :ref:`Custom Transport Descriptors <user_manual_configuration_dds_custom_transport_descriptors>` (UDP or Shared Memory only).
* Support :ref:`Ignore Participant Flags <user_manual_configuration_dds_ignore_participant_flags>`.

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

* Print only active participants when using verbose mode in ``participants`` command.
* Fix C++ *namespace* ambiguities in yaml configuration.
* Change default log-filter to only show warning coming from DDS Spy source code.
* Filter out topics associated to services (RPC).
* Parameterize simulated endpoints.

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

* Update introduction section in README file.

This release includes the following change in the **Continuous Integration** process:

* Update CI to use `eProsima CI <https://github.com/eProsima/eProsima-CI>`__.

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

0 comments on commit 3c36e7b

Please sign in to comment.