From 7c580aa46a5f6959b3123ee8048861149e37b089 Mon Sep 17 00:00:00 2001 From: Denisa Date: Wed, 5 Feb 2025 12:42:48 +0100 Subject: [PATCH 1/2] Add release notes for version 0.3.0 Signed-off-by: Denisa --- amlip_docs/rst/notes/forthcoming_version.rst | 13 +--- amlip_docs/rst/notes/notes.rst | 33 +++------ .../rst/notes/previous_versions/v0.2.0.rst | 67 +++++++++++++++++++ 3 files changed, 80 insertions(+), 33 deletions(-) create mode 100644 amlip_docs/rst/notes/previous_versions/v0.2.0.rst diff --git a/amlip_docs/rst/notes/forthcoming_version.rst b/amlip_docs/rst/notes/forthcoming_version.rst index 95356725..8da40f06 100644 --- a/amlip_docs/rst/notes/forthcoming_version.rst +++ b/amlip_docs/rst/notes/forthcoming_version.rst @@ -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 will include a new **AML-IP node**: - -* :ref:`Fiware `: node that interacts with FIWARE Context Broker to handle inference data. +################### \ No newline at end of file diff --git a/amlip_docs/rst/notes/notes.rst b/amlip_docs/rst/notes/notes.rst index 145a7e32..fdc15d57 100644 --- a/amlip_docs/rst/notes/notes.rst +++ b/amlip_docs/rst/notes/notes.rst @@ -4,39 +4,27 @@ .. comment the include of forthcoming when new info is added -.. include:: forthcoming_version.rst +.. .. include:: forthcoming_version.rst ############## -Version v0.2.0 +Version v0.3.0 ############## This release adds new **features**: -* Support Fast CDR v2.2.0. -* Implement asynchronous request model in ``ModelManagerReceiver``. -* Add ``fastdds.application.id`` property to participants and endpoints. -* Add ``fastdds.application.metadata`` property to participants and endpoints. -* Add ``MainNode`` constructor with ``domain`` parameter in Python bindings. -* Add Python bindings for Agent Nodes. -* Rename ``agent_tool`` package to ``amlip_agent``. +This release adds new features: -This includes the following **Bugfixes**: - -* Update ``AsyncComputingNode`` and ``AsyncInferenceNode`` to only stop if the current state is running and only run if the current state is stopped. -* ASAN (Address Sanitizer) fixes. -* Fix allowlist namespacing in ``AgentNode``. -* Call change status in ``AsyncComputingNode``. +* :ref:`Fiware `: node that interacts with FIWARE Context Broker to handle inference data. +* Upgrade to Ubuntu Noble (24.04). +* Remove Ubuntu Focal (20.04) from the CI. This release includes the following **CI improvements**: -* Migrate CI actions to use eProsima-CI. -* Include branch environment variables in CI configuration. +* Support for multiple versions of Fast DDS. This release add new **Documentation features**: -* Add instructions to build the Docker image. -* Add ``Agent Tool`` section. -* Add ``Enabling Technologies`` and ``Internal Protocols`` sections. +* Add Fiware Node Documentation. This release includes the following *Dependencies Update*: @@ -53,12 +41,12 @@ This release includes the following *Dependencies Update*: - `v1.3.1 `_ * - Fast CDR - `eProsima/Fast-CDR `_ - - `v1.1.0 `_ - `v2.2.1 `_ + - `v2.2.6 `_ * - Fast DDS - `eProsima/Fast-DDS `_ - - `v2.11.0 `_ - `v2.14.0 `_ + - `v2.14.4 `_ * - Dev Utils - `eProsima/dev-utils `_ - `v0.4.0 `_ @@ -77,4 +65,5 @@ This release includes the following *Dependencies Update*: Previous Versions ################# +.. include:: previous_versions/v0.2.0.rst .. include:: previous_versions/v0.1.0.rst diff --git a/amlip_docs/rst/notes/previous_versions/v0.2.0.rst b/amlip_docs/rst/notes/previous_versions/v0.2.0.rst new file mode 100644 index 00000000..d5e25eee --- /dev/null +++ b/amlip_docs/rst/notes/previous_versions/v0.2.0.rst @@ -0,0 +1,67 @@ +.. include:: ../exports/alias.include + +############## +Version v0.2.0 +############## + +This release adds new **features**: + +* Support Fast CDR v2.2.0. +* Implement asynchronous request model in ``ModelManagerReceiver``. +* Add ``fastdds.application.id`` property to participants and endpoints. +* Add ``fastdds.application.metadata`` property to participants and endpoints. +* Add ``MainNode`` constructor with ``domain`` parameter in Python bindings. +* Add Python bindings for Agent Nodes. +* Rename ``agent_tool`` package to ``amlip_agent``. + +This includes the following **Bugfixes**: + +* Update ``AsyncComputingNode`` and ``AsyncInferenceNode`` to only stop if the current state is running and only run if the current state is stopped. +* ASAN (Address Sanitizer) fixes. +* Fix allowlist namespacing in ``AgentNode``. +* Call change status in ``AsyncComputingNode``. + +This release includes the following **CI improvements**: + +* Migrate CI actions to use eProsima-CI. +* Include branch environment variables in CI configuration. + +This release add new **Documentation features**: + +* Add instructions to build the Docker image. +* Add ``Agent Tool`` section. +* Add ``Enabling Technologies`` and ``Internal Protocols`` sections. + +This release includes the following *Dependencies Update*: + +.. list-table:: + :header-rows: 1 + + * - + - Repository + - Old Version + - New Version + * - Foonathan Memory Vendor + - `eProsima/foonathan_memory_vendor `_ + - `v1.3.1 `_ + - `v1.3.1 `_ + * - Fast CDR + - `eProsima/Fast-CDR `_ + - `v1.1.0 `_ + - `v2.2.1 `_ + * - Fast DDS + - `eProsima/Fast-DDS `_ + - `v2.11.0 `_ + - `v2.14.0 `_ + * - Dev Utils + - `eProsima/dev-utils `_ + - `v0.4.0 `_ + - `v0.6.0 `_ + * - DDS Pipe + - `eProsima/DDS-Pipe `_ + - `v0.2.0 `__ + - `v0.4.0 `__ + * - DDS Router + - `eProsima/DDS-Router `_ + - `v2.0.0 `__ + - `v2.2.0 `__ From 6298b7c0938fbbfc5678830782f3c738f501f0a0 Mon Sep 17 00:00:00 2001 From: Denisa Date: Wed, 5 Feb 2025 16:26:18 +0100 Subject: [PATCH 2/2] Fix docs compilation Signed-off-by: Denisa --- amlip_docs/rst/notes/forthcoming_version.rst | 2 +- amlip_docs/rst/notes/previous_versions/v0.2.0.rst | 5 +---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/amlip_docs/rst/notes/forthcoming_version.rst b/amlip_docs/rst/notes/forthcoming_version.rst index 8da40f06..676dcc54 100644 --- a/amlip_docs/rst/notes/forthcoming_version.rst +++ b/amlip_docs/rst/notes/forthcoming_version.rst @@ -4,4 +4,4 @@ ################### Forthcoming Version -################### \ No newline at end of file +################### diff --git a/amlip_docs/rst/notes/previous_versions/v0.2.0.rst b/amlip_docs/rst/notes/previous_versions/v0.2.0.rst index d5e25eee..f90414e4 100644 --- a/amlip_docs/rst/notes/previous_versions/v0.2.0.rst +++ b/amlip_docs/rst/notes/previous_versions/v0.2.0.rst @@ -1,8 +1,5 @@ -.. include:: ../exports/alias.include - -############## Version v0.2.0 -############## +============== This release adds new **features**: