Prepare for release 3.1.1 (#993)

* Refs #21832. Add notes for 3.1.1 Signed-off-by: Miguel Company <[email protected]> * Refs #21832. Bump version to 3.1.1 Signed-off-by: Miguel Company <[email protected]> * Refs #21832. Update related products and dependencies. Signed-off-by: Miguel Company <[email protected]> * Refs #21832. Apply review suggestions Signed-off-by: Miguel Company <[email protected]> --------- Signed-off-by: Miguel Company <[email protected]>
eProsima · Dec 19, 2024 · 2b44ed6 · 2b44ed6
1 parent 7fc5bcb
commit 2b44ed6
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 9 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -401,9 +401,9 @@ def configure_doxyfile(
 # built documents.
 #
 # The short X.Y version.
-version = u'3.1.0'
+version = u'3.1.1'
 # The full version, including alpha/beta/rc tags.
-release = u'3.1.0'
+release = u'3.1.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst
@@ -5,7 +5,7 @@
 Information about the release lifecycle can be found
 `here <https://github.com/eProsima/Fast-DDS/blob/master/RELEASE_SUPPORT.md>`_.
 
-.. include:: previous_versions/v3.1.0.rst
+.. include:: previous_versions/v3.1.1.rst
 
 .. seealso::
 

diff --git a/docs/notes/previous_versions/supported_versions.rst b/docs/notes/previous_versions/supported_versions.rst
@@ -4,6 +4,7 @@ Supported versions
 Version 3.1
 -----------
 
+.. include:: v3.1.1.rst
 .. include:: v3.1.0.rst
 
 Version 3.0

diff --git a/docs/notes/previous_versions/v3.1.0.rst b/docs/notes/previous_versions/v3.1.0.rst
@@ -1,5 +1,5 @@
-`Version 3.1.0 (latest) <https://fast-dds.docs.eprosima.com/en/v3.1.0/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 3.1.0 <https://fast-dds.docs.eprosima.com/en/v3.1.0/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This minor release includes the following **features** in an ABI compatible manner:
 

diff --git a/docs/notes/previous_versions/v3.1.1.rst b/docs/notes/previous_versions/v3.1.1.rst
@@ -0,0 +1,34 @@
+`Version 3.1.1 (latest) <https://fast-dds.docs.eprosima.com/en/v3.1.1/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This patch release includes the following **features** in an ABI compatible manner:
+
+#. New property to select preferred key agreement algorithm
+
+This release includes the following **fixes**:
+
+#. Fix reach of maximum buffers in ``asio::send_to``
+#. Fix TCP discovery server locators translation
+#. Fix unique network flows with TCP transports
+#. Address OSS-Fuzz` regressions in XML parsers
+#. Fix ``DataReaderHistory`` regression
+#. Fix destruction data-race on participant removal in intra-process
+#. Several fixes in security plugins and ``SecurityManager``
+#. Fix ``cmake`` generator evaluation
+#. Fix build with ``-Werror=template-id-cdtor``
+#. Fix potential deadlock between ``StatefulWriter`` and ``FlowController``
+
+This release includes the following **improvements**:
+
+#. Update commercial support section in README
+#. Rename ``RTPSParticipantImpl.h`` to ``RTPSParticipantImpl.hpp``
+#. Check if ``SHM`` transport is disabled in ``LARGE_DATA`` modes
+#. Improve Blackbox TCP tests suite
+#. Test examples on Windows CI
+#. Regenerate types with Fast DDS Gen 4.0.3
+
+.. important::
+
+    When upgrading to version 3.1.1 it is **highly recommended** to regenerate generated source from IDL files
+    using at least `Fast DDS-Gen v4.0.3 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v4.0.3>`_.
+    But it is advisable to regenerate them using the latest patch version of ``Fast DDS-Gen v4.0.x``.
diff --git a/docs/notes/versions.rst b/docs/notes/versions.rst
@@ -321,7 +321,7 @@ The following table shows the corresponding versions of the Fast DDS library dep
             * - Product
               - Related version
             * - `Fast CDR <https://github.com/eProsima/Fast-CDR/>`__
-              - `v2.2.5 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.5>`__
+              - `v2.2.6 <https://github.com/eProsima/Fast-CDR/releases/tag/v2.2.6>`__
             * - `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>`__
             * - `Asio <https://github.com/chriskohlhoff/asio>`__
@@ -427,13 +427,13 @@ Fast DDS as the core middleware.
             * - Product
               - Related version
             * - `Fast DDS Gen <https://github.com/eProsima/Fast-DDS-Gen/>`__
-              - `v4.0.2 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v4.0.2>`__
+              - `v4.0.3 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v4.0.3>`__
             * - `Fast DDS Gen - IDL parser <https://github.com/eProsima/IDL-Parser/>`__
-              - `v4.0.2 <https://github.com/eProsima/IDL-Parser/releases/tag/v4.0.2>`__
+              - `v4.0.3 <https://github.com/eProsima/IDL-Parser/releases/tag/v4.0.3>`__
             * - `Fast DDS python <https://github.com/eProsima/Fast-DDS-python/>`__
               - `v2.1.0 <https://github.com/eProsima/Fast-DDS-python/releases/tag/v2.1.0>`__
             * - `Shapes Demo <https://github.com/eProsima/ShapesDemo/>`__
-              - `v3.1.0 <https://github.com/eProsima/ShapesDemo/releases/tag/v3.1.0>`__
+              - `v3.1.1 <https://github.com/eProsima/ShapesDemo/releases/tag/v3.1.1>`__
             * - `Discovery Server <https://github.com/eProsima/Discovery-Server/>`__
               - `v2.0.0 <https://github.com/eProsima/Discovery-Server/releases/tag/v2.0.0>`__