Prepare for 3.1.3 EOL Release (#1081)

Mario-DL · web-flow · commit 74d032c55cc0 · 2025-06-09T15:08:24.000+02:00
* Refs #22800: Bump version to 3.1.3

Signed-off-by: Mario Dominguez &lt;mariodominguez@eprosima.com&gt;

* Refs #22800: Add 3.1.3 Release Notes

Signed-off-by: Mario Dominguez &lt;mariodominguez@eprosima.com&gt;

* Refs #22800: Add 2.10.7 RN

Signed-off-by: Mario Dominguez &lt;mariodominguez@eprosima.com&gt;

* Refs #22800: Mark 3.1.x as EOL and move 2.10.x to previous versions as EOL

Signed-off-by: Mario Dominguez &lt;mariodominguez@eprosima.com&gt;

* Refs #22800: spelling

Signed-off-by: Mario Dominguez &lt;mariodominguez@eprosima.com&gt;

---------

Signed-off-by: Mario Dominguez &lt;mariodominguez@eprosima.com&gt;
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.2'
+version = u'3.1.3'
 # The full version, including alpha/beta/rc tags.
-release = u'3.1.2'
+release = u'3.1.3'
 
 # 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.2.rst
+.. include:: previous_versions/v3.1.3.rst
 
 .. seealso::
 
diff --git a/docs/notes/previous_versions/previous_versions.rst b/docs/notes/previous_versions/previous_versions.rst
@@ -34,6 +34,18 @@ Version 2.11 (EOL)
 .. include:: v2.11.1.rst
 .. include:: v2.11.0.rst
 
+Version 2.10 (EOL)
+------------------
+
+.. include:: v2.10.7.rst
+.. include:: v2.10.6.rst
+.. include:: v2.10.5.rst
+.. include:: v2.10.4.rst
+.. include:: v2.10.3.rst
+.. include:: v2.10.2.rst
+.. include:: v2.10.1.rst
+.. include:: v2.10.0.rst
+
 Version 2.9 (EOL)
 -----------------
 
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.3.rst
 .. include:: v3.1.2.rst
 .. include:: v3.1.1.rst
 .. include:: v3.1.0.rst
@@ -17,17 +18,6 @@ Version 2.14
 .. include:: v2.14.1.rst
 .. include:: v2.14.0.rst
 
-Version 2.10
-------------
-
-.. include:: v2.10.6.rst
-.. include:: v2.10.5.rst
-.. include:: v2.10.4.rst
-.. include:: v2.10.3.rst
-.. include:: v2.10.2.rst
-.. include:: v2.10.1.rst
-.. include:: v2.10.0.rst
-
 Version 2.6 (maintenance)
 -------------------------
 
diff --git a/docs/notes/previous_versions/v2.10.0.rst b/docs/notes/previous_versions/v2.10.0.rst
@@ -1,5 +1,6 @@
-`Version 2.10.0 <https://fast-dds.docs.eprosima.com/en/v2.10.0/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 2.10.0 (EOL) <https://fast-dds.docs.eprosima.com/en/v2.10.0/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 
 This minor release includes several new features, improvements and bugfixes.
 
diff --git a/docs/notes/previous_versions/v2.10.1.rst b/docs/notes/previous_versions/v2.10.1.rst
@@ -1,5 +1,6 @@
-`Version 2.10.1 <https://fast-dds.docs.eprosima.com/en/v2.10.1/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 2.10.1 (EOL) <https://fast-dds.docs.eprosima.com/en/v2.10.1/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 
 This release includes the following **feature** in an ABI compatible way:
 
diff --git a/docs/notes/previous_versions/v2.10.2.rst b/docs/notes/previous_versions/v2.10.2.rst
@@ -1,5 +1,6 @@
-`Version 2.10.2 <https://fast-dds.docs.eprosima.com/en/v2.10.2/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 2.10.2 (EOL) <https://fast-dds.docs.eprosima.com/en/v2.10.2/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 
 This release includes the following **improvements**:
 
diff --git a/docs/notes/previous_versions/v2.10.4.rst b/docs/notes/previous_versions/v2.10.4.rst
@@ -1,5 +1,5 @@
-`Version 2.10.4 <https://fast-dds.docs.eprosima.com/en/v2.10.4/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 2.10.4 (EOL) <https://fast-dds.docs.eprosima.com/en/v2.10.4/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **features** in an ABI compatible manner:
 
diff --git a/docs/notes/previous_versions/v2.10.5.rst b/docs/notes/previous_versions/v2.10.5.rst
@@ -1,5 +1,5 @@
-`Version 2.10.5 <https://fast-dds.docs.eprosima.com/en/v2.10.5/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 2.10.5 (EOL) <https://fast-dds.docs.eprosima.com/en/v2.10.5/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **features** in an ABI compatible manner:
 
diff --git a/docs/notes/previous_versions/v2.10.6.rst b/docs/notes/previous_versions/v2.10.6.rst
@@ -1,5 +1,5 @@
-`Version 2.10.6 <https://fast-dds.docs.eprosima.com/en/v2.10.6/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 2.10.6 (EOL) <https://fast-dds.docs.eprosima.com/en/v2.10.6/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **fixes**:
 
diff --git a/docs/notes/previous_versions/v2.10.7.rst b/docs/notes/previous_versions/v2.10.7.rst
@@ -0,0 +1,51 @@
+`Version 2.10.7 (EOL) <https://fast-dds.docs.eprosima.com/en/v2.10.6/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This release includes the following **fixes**:
+
+#. Fix `CVE-2025-24807 <https://www.cve.org/CVERecord?id=CVE-2025-24807>`_
+#. Release ``participant_stateless`` secure builtin writer history change when authentication has finished
+#. Improve ``OpenSSL`` lifecycle handling
+#. Fix comparison in ``is_update_allowed``
+#. Arithmetic overflow in fragment size calculations
+#. Fix ``-Werror=template-id-cdtor``
+#. Fix double-locking issue in ``DataSharingListener``
+#. Improve ``PDPClient`` initialization
+#. Fix unique network flows with TCP transports
+#. Decouple transport receivers creation using unique network flows
+#. Fix EDP reliability timings
+#. Fix ``several_writers_on_unack_sample_removed`` flaky test
+#. Reliable volatile change dropped when all history acked
+#. Create initial connection for TCP initial peers
+#. Filter interested readers on PDP writer
+#. Fix cleanup race condition with exclusive and shared lock files
+#. Fix TCP discovery server locators translation
+#. Use correct algorithm strings on ``PermissionsToken`` and ``IdentityToken``
+#. Fix potential deadlock between ``StatefulWriter`` and ``FlowController``
+#. Fix log category name macro collision in ``MacOS``
+#. Unacknowledged sample removed in KeepAll mode
+#. Fix assertion on ``OutputTrafficManager``
+
+This release includes the following **improvements**:
+
+#. Log any errors before ``cancel_init``
+#. Improve ``max_allocations`` calculation on SHM transport
+#. New property to select preferred key agreement algorithm
+#. Update reception timestamp when it is added to the instance
+#. Improve Blackbox TCP tests suite
+#. Handle socket buffer size setting when system's maximum exceeded
+#. Address some compilation warnings with GCC latest
+#. Refactor builtin writers & readers creation
+#. Update sqlite from 3.36.0 to 3.47.2
+#. Regenerate code with Fast DDS Gen v2.5.3
+
+Github CI management:
+
+#. Force Asio thirdparty in MacOS CI
+#. Get correct Fast CDR related branch in CI
+#. Update submodules when cloning Fast DDS on CI
+
+.. note::
+  If you are upgrading from a version older than 1.7.0, it is **required** to regenerate generated source from IDL
+  files using *fastddsgen*.
+  If you are upgrading from any older version, regenerating the code is *highly recommended*.
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 <https://fast-dds.docs.eprosima.com/en/v3.1.0/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 3.1.0 (EOL) <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
@@ -1,5 +1,5 @@
-`Version 3.1.1 <https://fast-dds.docs.eprosima.com/en/v3.1.1/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 3.1.1 (EOL) <https://fast-dds.docs.eprosima.com/en/v3.1.1/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This patch release includes the following **features** in an ABI compatible manner:
 
diff --git a/docs/notes/previous_versions/v3.1.2.rst b/docs/notes/previous_versions/v3.1.2.rst
@@ -1,5 +1,5 @@
-`Version 3.1.2 (latest) <https://fast-dds.docs.eprosima.com/en/v3.1.2/index.html>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+`Version 3.1.2 (EOL) <https://fast-dds.docs.eprosima.com/en/v3.1.2/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This release includes the following **fixes**:
 
diff --git a/docs/notes/previous_versions/v3.1.3.rst b/docs/notes/previous_versions/v3.1.3.rst
@@ -0,0 +1,41 @@
+`Version 3.1.3 (EOL)  <https://fast-dds.docs.eprosima.com/en/v3.1.3/index.html>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This release includes the following **improvements**:
+
+#. Support compiler ``MSYS2-MinGW``
+#. Improve ``max_allocations`` calculation on SHM transport
+#. Filter interested readers on ``PDP writer``
+#. Update types with ``Fast DDS Gen v4.0.4``
+#. Refactor builtin writers and readers creation
+#. Add modules support to ``idl_serialize``
+#. Improve DS routines
+
+This release includes the following **fixes**:
+
+#. Fix error handling logic in ``try_setting_buffer_size``
+#. Avoid redefinition warning for ``OPENSSL_API_COMPAT``
+#. Solve fuzz ``XMLParser Null-dereference``
+#. Remove repeated header include and Fix log
+#. Fix Security tag in ``DS CLI``
+#. Fix assertion on ``OutputTrafficManager``
+#. Fix cleanup race condition with exclusive and shared lock files
+#. Remove ``SHM`` option from discovery server example
+#. Fix ``several_writers_on_unack_sample_removed`` flaky test
+#. Avoid sending statistics msg with big messages and no fragmentation
+#. Fix windows example tests in Debug and mitigate ``rtps`` example flakiness
+#. Address some compilation warnings with GCC latest
+#. Solve Discovery Server race conditions
+#. Fix ``oss-fuzz`` regressions
+#. Avoid Data Race in Reader Locator
+
+This release includes the following **ci improvements**:
+
+#. Get correct Fast CDR related branch in CI
+#. Force Asio ``Thirdparty`` in MacOS CI
+
+.. important::
+
+    When upgrading to version 3.1.3 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
