Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump version to v1.0.0 & add release notes #157

Merged
merged 2 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions VERSION
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
VERSION_MAJOR 0
VERSION_MINOR 3
VERSION_MAJOR 1
VERSION_MINOR 0
VERSION_PATCH 0
2 changes: 1 addition & 1 deletion controller/controller_tool/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>controller_tool</name>
<version>0.3.0</version>
<version>1.0.0</version>
<description>Tool used for externally controlling a running DDS Recorder</description>
<maintainer email="[email protected]">Raúl Sánchez-Mateos</maintainer>
<maintainer email="[email protected]">Javier París</maintainer>
Expand Down
2 changes: 1 addition & 1 deletion ddsrecorder/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>ddsrecorder_tool</name>
<version>0.3.0</version>
<version>1.0.0</version>
<description>
*eProsima DDS Recorder* Application to execute a DDS Recorder from a YAML configuration file.
</description>
Expand Down
2 changes: 1 addition & 1 deletion ddsrecorder_participants/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>ddsrecorder_participants</name>
<version>0.3.0</version>
<version>1.0.0</version>
<description>
DDS Recorder Participants implementation.
</description>
Expand Down
2 changes: 1 addition & 1 deletion ddsrecorder_yaml/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>ddsrecorder_yaml</name>
<version>0.3.0</version>
<version>1.0.0</version>
<description>
*eprosima DDS Recorder* Yaml Module is a C++ implementation to read and parse YAML configuration files.
</description>
Expand Down
2 changes: 1 addition & 1 deletion ddsreplayer/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>ddsreplayer_tool</name>
<version>0.3.0</version>
<version>1.0.0</version>
<description>
*eProsima DDS Replayer* Application to execute a DDS Replayer from a YAML configuration file.
</description>
Expand Down
2 changes: 1 addition & 1 deletion docs/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>ddsrecorder_docs</name>
<version>0.3.0</version>
<version>1.0.0</version>
<description>
*eprosima DDS Record and Replay* Documentation built with sphinx and deployed in ReadTheDocs.
</description>
Expand Down
2 changes: 1 addition & 1 deletion docs/rst/installation/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The steps to run |ddsrecord| in a Docker container are explained below.
--ipc=host \
--privileged \
-v /<dds_recorder_ws>/DDS_RECORDER_CONFIGURATION.yaml:/root/DDS_RECORDER_CONFIGURATION.yaml \
ubuntu-ddsrecorder:v0.3.0
ubuntu-ddsrecorder:version

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.
Expand Down
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
###################

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 **Recording features**:

* :ref:`Resource Limits <recorder_specs_logging>`.
28 changes: 15 additions & 13 deletions docs/rst/notes/notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,25 @@

.. _notes:

.. include:: forthcoming_version.rst
.. .. include:: forthcoming_version.rst

##############
Version v0.4.0
Version v1.0.0
##############

This release includes the following **Recording features**:
This release includes the following **Features**:

* Publish the :ref:`Logs <recorder_specs_logging>` in a DDS topic.
* New :ref:`Monitor <recorder_specs_monitor>` module.
* Add support for Fast DDS v3.

This release includes the following **DDS Recorder tool configuration features**:
This release includes the following **Recording features**:

* New configuration option ``logging`` to configure the :ref:`Logs <recorder_specs_logging>`.
* :ref:`Resource Limits <recorder_usage_configuration_resource_limits>`.

This release includes the following **DDS Replayer tool configuration features**:
This release includes the following **CI improvements**:

* New configuration option ``logging`` to configure the :ref:`Logs <replayer_specs_logging>`.
* 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**:

Expand All @@ -36,26 +37,27 @@ 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>`_
- `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>`_
- `v2.2.4 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.4>`_
* - Fast DDS
- `eProsima/Fast-DDS <https://github.com/eProsima/Fast-DDS>`_
- `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>`_
- `v3.0.1 <https://github.com/eProsima/Fast-DDS/releases/tag/v3.0.1>`_
* - Dev Utils
- `eProsima/dev-utils <https://github.com/eProsima/dev-utils>`_
- `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>`_
- `v1.0.0 <https://github.com/eProsima/dev-utils/releases/tag/v1.0.0>`_
* - DDS Pipe
- `eProsima/DDS-Pipe <https://github.com/eProsima/DDS-Pipe.git>`_
- `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>`__
- `v1.0.0 <https://github.com/eProsima/DDS-Pipe/releases/tag/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
46 changes: 46 additions & 0 deletions docs/rst/notes/previous_versions/v0.4.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@

Version v0.4.0
==============

This release includes the following **Recording features**:

* Publish the :ref:`Logs <recorder_specs_logging>` in a DDS topic.
* New :ref:`Monitor <recorder_specs_monitor>` module.

This release includes the following **DDS Recorder tool configuration features**:

* New configuration option ``logging`` to configure the :ref:`Logs <recorder_specs_logging>`.

This release includes the following **DDS Replayer tool configuration features**:

* New configuration option ``logging`` to configure the :ref:`Logs <replayer_specs_logging>`.

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>`_
- `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.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.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.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>`__
Loading