Skip to content

Commit d1b6cbd

Browse files
jparisujparisu
authored
Release v0.4.0 (#246)
* Refs #15060: Add version argument in docs Signed-off-by: jparisu <javierparis@eprosima.com> * Refs #15060: Prepare release notes Signed-off-by: jparisu <javierparis@eprosima.com> * Refs #15060: Bump version Signed-off-by: jparisu <javierparis@eprosima.com> * Refs #15060: fix spelling typo Signed-off-by: jparisu <javierparis@eprosima.com>
1 parent 717a82a commit d1b6cbd

File tree

13 files changed

+111
-74
lines changed

13 files changed

+111
-74
lines changed

‎VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
VERSION_MAJOR 0
2-
VERSION_MINOR 3
2+
VERSION_MINOR 4
33
VERSION_PATCH 0

‎ddsrouter_cmake/package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
33
<package format="3">
44
<name>ddsrouter_cmake</name>
5-
<version>0.0.0</version>
5+
<version>0.4.0</version>
66
<description>
77
*eprosima AML-IP* CMake utils and macros.
88
</description>

‎ddsrouter_core/package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
33
<package format="3">
44
<name>ddsrouter_core</name>
5-
<version>0.3.0</version>
5+
<version>0.4.0</version>
66
<description>
77
*eprosima DDS Router* C++ library to communicate isolated DDS networks between each other. Use in isolated machines an WAN scenarios.
88
</description>

‎ddsrouter_utils/package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
33
<package format="3">
44
<name>ddsrouter_utils</name>
5-
<version>0.3.0</version>
5+
<version>0.4.0</version>
66
<description>
77
*eprosima DDS Router* Utils Module is a C++ implementation for some generic utils methods.
88
</description>

‎ddsrouter_yaml/package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
33
<package format="3">
44
<name>ddsrouter_yaml</name>
5-
<version>0.3.0</version>
5+
<version>0.4.0</version>
66
<description>
77
*eprosima DDS Router* Yaml Module is a C++ implementation for handling events in multithreading executions as PeriodicTimers, Signals, FileWatchers, etc.
88
</description>

‎docs/rst/notes/forthcoming_version.rst

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,9 @@
11

2+
.. todo:
3+
remove orphan tag when new info added to this file
4+
5+
:orphan:
6+
27
###################
38
Forthcoming Version
49
###################
5-
6-
Next release will include the following **improvementes**:
7-
8-
* New :code:`FastPayloalPool` class that will allow unblocking access to shared payloads stored by FastDDS and
9-
DDS Router.
10-
This slightly improves the **performance** of the router.
11-
12-
* New :code:`ThreadPool` class for handling parallel processing.
13-
Limit the number of threads spawned by the DDS Router, improving the performance of the application.
14-
The user can set-up this parameter on the YAML configuration :ref:`thread_configuration`.
15-
16-
Next release will include the following **major changes**:
17-
18-
* New :ref:`yaml_validator`, a simple tool to assert the correctness of DDS Router configuration files.
19-
* The internal package `ddsrouter_event` is joint within the internal package `ddsrouter_utils`.
20-
21-
Next release will fix the following **minor bugs**:
22-
23-
* Fix race condition occurred when handling signals (due to concurrent access to *SignalManager* singleton).
24-
* Bug in TLS Configuration initialization when setting server configuration files.

‎docs/rst/notes/notes.rst

Lines changed: 27 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2,68 +2,55 @@
22

33
.. _release_notes:
44

5-
.. include:: forthcoming_version.rst
5+
.. todo:
6+
uncomment the include of forthcoming when new info is added
7+
.. include:: forthcoming_version.rst
68
79
##############
8-
Version v0.3.0
10+
Version v0.4.0
911
##############
1012

11-
This release includes the following **major changes**:
12-
13-
* New DDS Router library that provides the DDS Router features through a C++ API.
14-
* Division of DDS Router application into several packages.
13+
This release includes the following **features**:
1514

16-
- `ddsrouter_event`: C++ library which implements System Operating (SO)-dependent signal handlers.
17-
- `ddsrouter_utils`: C++ library which implements various utility functions.
18-
- `ddsrouter_core`: C++ library which implements the DDS Router operation and exports the DDS Router C++ API.
19-
- `ddsrouter_yaml`: C++ library to parse the DDS Router *yaml* configuration files.
20-
- `ddsrouter_tool`: DDS Router end-user application.
21-
* New dynamic topic discovery feature to automatically discover DDS Topics in a DDS network.
22-
* Allow using wildcard characters to define topics in ``allowlist`` and ``blocklist``.
23-
* Build internal topic tracks via the ``builtin-topics`` configuration.
15+
* New :ref:`yaml_validator`, a simple tool to assert the correctness of DDS Router configuration files.
16+
* New :ref:`user_manual_user_interface_version_argument` to show the current version of DDS Router.
2417

18+
This release includes the following **improvementes**:
2519

26-
This release includes the following **Routing features**:
20+
* New :code:`FastPayloalPool` class that will allow unblocking access to shared payloads stored by FastDDS and
21+
DDS Router.
22+
This slightly improves the **performance** of the router.
2723

28-
* Apply DDS Topic filtering rules using the ``allowlist`` and ``blocklist`` lists.
24+
* New :code:`ThreadPool` class for handling parallel processing.
25+
Limit the number of threads spawned by the DDS Router, improving the performance of the application.
26+
The user can set-up this parameter on the YAML configuration :ref:`thread_configuration`.
2927

28+
This release includes the following **major changes**:
3029

31-
This release includes the following **User Interface features**:
30+
* New auxiliary package :code:`ddsrouter_cmake` to implement general CMake functions and tools.
31+
* The internal package :code:`ddsrouter_event` is joint within the internal package :code:`ddsrouter_utils`.
3232

33-
* Upgrade the *yaml* configuration file to version 2.0 which breaks compatibility with version 1.0.
34-
* Support for both version 1.0 and version 2.0 of the *yaml* configuration file, maintaining version 1.0 by default.
35-
* Improve reporting of errors resulting from parsing a malformed *yaml* configuration file.
33+
This release includes the following **minor changes**:
3634

35+
* Refactor all :code:`enum` to :code:`enum class`.
3736

3837
This release includes the following **Continuous-Integration features**:
3938

40-
* Add tests for the *yaml* parsing library (`ddsrouter_yaml`).
41-
* Specific testing GitHub actions for each DDS Router package for both Windows and Linux platforms.
42-
43-
44-
This release fixes the following **major bugs**:
45-
46-
* Fix deadlock between Track and Fast DDS Reader mutex.
47-
* Support any size for in and out messages.
48-
39+
* New CI workflow to build dependencies nightly.
40+
This allows to run the CI faster, as the build is only done for the ddsrouter packages and not the whole fastdds.
41+
* Add :code:`ubuntu 22.04` to platforms in CI.
42+
* Add :code:`windows 19` to platforms in CI.
4943

5044
This release fixes the following **minor bugs**:
5145

52-
* Fix parsing of *reload-time* executable argument.
53-
* Handle signals in dedicated threads to prevent hangs when terminating execution.
54-
* Fix rare deadlock in EventHandler when destroying and callback called.
55-
56-
57-
This release includes the following **Documentation features**:
58-
59-
* DDS Router execution from a provided Docker image.
60-
* Update all examples of *yaml* configuration files to be consistent with the new *yaml* configuration version.
61-
* High-level repository structure description and developer contribution guidelines.
62-
* Improved and extended :ref:`topic_filtering` section according to the new dynamic topic discovery functionality.
46+
* Fix race condition occurred when handling signals (due to concurrent access to *SignalManager* singleton).
47+
* Bug in TLS Configuration initialization when setting server configuration files.
48+
* Set FastDDS DomainParticipants and Readers listeners after creation to avoid race conditions in entities creation.
6349

6450
#################
6551
Previous Versions
6652
#################
6753

54+
.. include:: previous_versions/v0.3.0.rst
6855
.. include:: previous_versions/v0.2.0.rst
6956
.. include:: previous_versions/v0.1.0.rst

‎docs/rst/notes/previous_versions/v0.3.0.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
2+
Version v0.3.0
3+
==============
4+
5+
This release includes the following **major changes**:
6+
7+
* New DDS Router library that provides the DDS Router features through a C++ API.
8+
* Division of DDS Router application into several packages.
9+
10+
- `ddsrouter_event`: C++ library which implements System Operating (SO)-dependent signal handlers.
11+
- `ddsrouter_utils`: C++ library which implements various utility functions.
12+
- `ddsrouter_core`: C++ library which implements the DDS Router operation and exports the DDS Router C++ API.
13+
- `ddsrouter_yaml`: C++ library to parse the DDS Router *yaml* configuration files.
14+
- `ddsrouter_tool`: DDS Router end-user application.
15+
* New dynamic topic discovery feature to automatically discover DDS Topics in a DDS network.
16+
* Allow using wildcard characters to define topics in ``allowlist`` and ``blocklist``.
17+
* Build internal topic tracks via the ``builtin-topics`` configuration.
18+
19+
20+
This release includes the following **Routing features**:
21+
22+
* Apply DDS Topic filtering rules using the ``allowlist`` and ``blocklist`` lists.
23+
24+
25+
This release includes the following **User Interface features**:
26+
27+
* Upgrade the *yaml* configuration file to version 2.0 which breaks compatibility with version 1.0.
28+
* Support for both version 1.0 and version 2.0 of the *yaml* configuration file, maintaining version 1.0 by default.
29+
* Improve reporting of errors resulting from parsing a malformed *yaml* configuration file.
30+
31+
32+
This release includes the following **Continuous-Integration features**:
33+
34+
* Add tests for the *yaml* parsing library (`ddsrouter_yaml`).
35+
* Specific testing GitHub actions for each DDS Router package for both Windows and Linux platforms.
36+
37+
38+
This release fixes the following **major bugs**:
39+
40+
* Fix deadlock between Track and Fast DDS Reader mutex.
41+
* Support any size for in and out messages.
42+
43+
44+
This release fixes the following **minor bugs**:
45+
46+
* Fix parsing of *reload-time* executable argument.
47+
* Handle signals in dedicated threads to prevent hangs when terminating execution.
48+
* Fix rare deadlock in EventHandler when destroying and callback called.
49+
50+
51+
This release includes the following **Documentation features**:
52+
53+
* DDS Router execution from a provided Docker image.
54+
* Update all examples of *yaml* configuration files to be consistent with the new *yaml* configuration version.
55+
* High-level repository structure description and developer contribution guidelines.
56+
* Improved and extended :ref:`topic_filtering` section according to the new dynamic topic discovery functionality.

‎docs/rst/spelling_wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ entrypoint
1515
eProsima
1616
executables
1717
fastcdr
18+
fastdds
1819
fastrtps
1920
github
2021
gMock

‎docs/rst/user_manual/user_interface.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,13 @@ It shows the usage information of the application.
8383
It will build a communication bridge between the different Participants included in the provided configuration file.
8484
To stop the execution gracefully use SIGINT (C^) or SIGTERM (kill) signals.
8585
General options:
86-
-h --help Print this help message.
87-
-c --config-path Path to the Configuration File (yaml format) [Default: ./DDS_ROUTER_CONFIGURATION.yaml].
88-
-r --reload-time Time period in seconds to reload configuration file. This is needed when File Watcher
89-
functionality is not available (e.g. config file is a symbolic link).
90-
Value 0 does not reload file. [Default: 0].
91-
-d --debug Activate debug Logs (be aware that some logs may require specific CMAKE compilation options).
86+
-h --help Print this help message.
87+
-c --config-path Path to the Configuration File (yaml format) [Default: ./DDS_ROUTER_CONFIGURATION.yaml].
88+
-r --reload-time Time period in seconds to reload configuration file. This is needed when File Watcher
89+
functionality is not available (e.g. config file is a symbolic link).
90+
Value 0 does not reload file. [Default: 0].
91+
-d --debug Activate debug Logs (be aware that some logs may require specific CMAKE compilation options).
92+
-v --version Print version, branch and commit hash.
9293
9394
9495
.. _user_manual_user_interface_configuration_file_argument:
@@ -125,6 +126,13 @@ or compiled with CMake option ``LOG_INFO=ON``.
125126
or ``CMAKE_BUILD_TYPE`` different to ``Debug``.
126127

127128

129+
.. _user_manual_user_interface_version_argument:
130+
131+
Version Argument
132+
^^^^^^^^^^^^^^^^
133+
134+
It shows the current version of the DDS Router and the hash of the last commit of the compiled code.
135+
128136

129137
.. _user_manual_user_interface_configuration_file:
130138

‎tools/ddsrouter_tool/package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
33
<package format="3">
44
<name>ddsrouter_tool</name>
5-
<version>0.3.0</version>
5+
<version>0.4.0</version>
66
<description>
77
*eprosima DDS Router* Application to execute a DDS Router from a YAML configuration file.
88
</description>

‎tools/ddsrouter_yaml_validator/package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
33
<package format="3">
44
<name>ddsrouter_yaml_validator</name>
5-
<version>0.3.0</version>
5+
<version>0.4.0</version>
66
<description>Tool used for validating DDS-Router configuration files</description>
77
<maintainer email="raul@eprosima.com">Raúl Sánchez-Mateos</maintainer>
88
<maintainer email="javierparis@eprosima.com">Javier París</maintainer>

‎tools/ddsrouter_yaml_validator/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
setup(
88
name=package_name,
9-
version='0.3.0',
9+
version='0.4.0',
1010
packages=[package_name],
1111
data_files=[
1212
('share/ament_index/resource_index/packages',

0 commit comments

Comments
 (0)