Skip to content

Commit

Permalink
Add v2.2.0 release notes (#442)
Browse files Browse the repository at this point in the history
* Add v2.2.0 release notes

Signed-off-by: Irene Bandera <irenebandera@eprosima.com>

* Apply changes

Signed-off-by: Irene Bandera <irenebandera@eprosima.com>

---------

Signed-off-by: Irene Bandera <irenebandera@eprosima.com>
  • Loading branch information
irenebm authored Mar 26, 2024
1 parent 27fa209 commit 4c5611a
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 30 deletions.
11 changes: 1 addition & 10 deletions docs/rst/notes/forthcoming_version.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,7 @@
.. add orphan tag when new info added to this file
.. :orphan:
:orphan:

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

The next release will include the following **Features**:

* Publish the :ref:`Logs <router_specs_logging>`.
* :ref:`Monitor <user_manual_configuration_specs_monitor>`.

The next release will include the following **Configuration features**:

* New configuration option ``logging`` to configure the :ref:`Logs <router_specs_logging>`.
33 changes: 13 additions & 20 deletions docs/rst/notes/notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,20 @@

.. _release_notes:

.. include:: forthcoming_version.rst
.. .. include:: forthcoming_version.rst
##############
Version v2.1.0
Version v2.2.0
##############

The next release will include the following **Features**:
This release includes the following **Features**:

* :ref:`Forwarding Routes <user_manual_configuration_forwarding_routes>`.
* :ref:`Remove Unused Entities <user_manual_configuration_remove_unused_entities>`.
* :ref:`Manual Topics <user_manual_configuration_manual_topics>`.
* :ref:`Max Transmission Rate <user_manual_configuration_max_tx_rate>`.
* :ref:`Max Reception Rate <user_manual_configuration_max_rx_rate>`.
* :ref:`Downsampling <user_manual_configuration_downsampling>`.
* :ref:`Discovery Trigger <user_manual_configuration_discovery_trigger>`.
* Rename the `max-depth` under the `specs` tag to `history-depth`.
* Set `app_id` and `app_metadata` attributes in *eProsima DDS Router* participants.
* Support both Fast CDR v1 and v2.
* Publish the :ref:`Logs <router_specs_logging>` in a DDS topic.
* New :ref:`Monitor <user_manual_configuration_specs_monitor>` module.

The next release will include the following **Bugfixes**:
This release includes the following **Configuration features**:

* Save the instance handle data for keyed topics.
* New ``logging`` configuration option to configure the DDS Router :ref:`internal logs <router_specs_logging>`.

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

Expand All @@ -40,25 +32,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.2 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.1.2>`_
- `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.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/v2.1.0.rst
.. include:: previous_versions/v2.0.0.rst
.. include:: previous_versions/v1.2.0.rst
.. include:: previous_versions/v1.1.0.rst
Expand Down
50 changes: 50 additions & 0 deletions docs/rst/notes/previous_versions/v2.1.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@

Version v2.1.0
==============

This release includes the following **Features**:

* :ref:`Forwarding Routes <user_manual_configuration_forwarding_routes>`.
* :ref:`Remove Unused Entities <user_manual_configuration_remove_unused_entities>`.
* :ref:`Manual Topics <user_manual_configuration_manual_topics>`.
* :ref:`Max Transmission Rate <user_manual_configuration_max_tx_rate>`.
* :ref:`Max Reception Rate <user_manual_configuration_max_rx_rate>`.
* :ref:`Downsampling <user_manual_configuration_downsampling>`.
* :ref:`Discovery Trigger <user_manual_configuration_discovery_trigger>`.
* Rename the `max-depth` under the `specs` tag to `history-depth`.
* Set `app_id` and `app_metadata` attributes in *eProsima DDS Router* participants.
* Support both Fast CDR v1 and v2.

This release includes the following **Bugfixes**:

* Save the instance handle data for keyed topics.

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.2 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.1.2>`_
* - 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 4c5611a

Please sign in to comment.