From f8446f2d06e6cb3067e1abc435e03d0e94afcb98 Mon Sep 17 00:00:00 2001 From: Raul Sanchez-Mateos Lizano Date: Wed, 28 Jun 2023 07:13:28 +0200 Subject: [PATCH] Add v0.2.0 release notes (#44) * Add v0.2.0 release notes Signed-off-by: Raul Sanchez-Mateos * Add missing include in docs Signed-off-by: Raul Sanchez-Mateos * Fix spellcheck Signed-off-by: Raul Sanchez-Mateos * Add release fixes to release notes Signed-off-by: Raul Sanchez-Mateos --------- Signed-off-by: Raul Sanchez-Mateos --- docs/rst/notes/forthcoming_version.rst | 5 -- docs/rst/notes/notes.rst | 54 +++++++++------------ docs/rst/notes/previous_versions/v0.1.0.rst | 38 +++++++++++++++ docs/rst/spelling_wordlist.txt | 1 + 4 files changed, 61 insertions(+), 37 deletions(-) create mode 100644 docs/rst/notes/previous_versions/v0.1.0.rst diff --git a/docs/rst/notes/forthcoming_version.rst b/docs/rst/notes/forthcoming_version.rst index e7c6cd52..fab57569 100644 --- a/docs/rst/notes/forthcoming_version.rst +++ b/docs/rst/notes/forthcoming_version.rst @@ -7,8 +7,3 @@ Forthcoming Version ################### -Next release will include the following **Configuration features**: - -* Support :ref:`Interface Whitelisting `. -* Support :ref:`Custom Transport Descriptors ` (UDP or Shared Memory only). -* Support :ref:`Ignore Participant Flags `. diff --git a/docs/rst/notes/notes.rst b/docs/rst/notes/notes.rst index 1c29feac..29011021 100644 --- a/docs/rst/notes/notes.rst +++ b/docs/rst/notes/notes.rst @@ -2,48 +2,38 @@ .. _notes: -##### -Notes -##### - .. TODO uncomment when there are forthcoming notes -.. include:: forthcoming_version.rst - -Version v0.1.0 -============== - -This is the first release of |espy|. - -This release includes several **features** regarding the introspection of DDS data, configuration and user interaction. - -This release includes the following **User Interface features**: - -* :ref:`Application executable arguments `. -* :ref:`Interactive application `. -* :ref:`One-shot application `. +.. .. include:: forthcoming_version.rst +############## +Version v0.2.0 +############## -This release includes the following **Configuration features**: +This release includes the following **Configuration Features**: -* Support :term:`YAML` :ref:`configuration file `. -* Support for allow and block topic filters at execution time and in run-time. -* Support :ref:`DDS configurations `. -* Support :ref:`Advanced configurations `. +* Support :ref:`Interface Whitelisting `. +* Support :ref:`Custom Transport Descriptors ` (UDP or Shared Memory only). +* Support :ref:`Ignore Participant Flags `. +This release includes the following **Internal Changes** and **Bugfixes**: -This release includes the following **Introspection features**: +* Print only active participants when using verbose mode in ``participants`` command. +* Fix C++ *namespace* ambiguities in yaml configuration. +* Change default log-filter to only show warning coming from DDS Spy source code. +* Filter out topics associated to services (RPC). +* Parameterize simulated endpoints. -* Get data of :term:`Domain Participants `. -* Get data of :term:`DataReaders ` and :term:`DataWriters `. -* Get data of :term:`Topics `. -* Print real-time DDS user data in human-readable format. +This release includes the following **Documentation Updates**: +* Update introduction section in README file. -This release includes the following **Documentation features**: +This release includes the following change in the **Continuous Integration** process: -* This same documentation. +* Update CI to use `eProsima CI `__. -This release includes the following **Installation features**: +################# +Previous Versions +################# -* *Dockerfile* to build an image of the application ``Fast-DDS-Spy/docker``. +.. include:: ./previous_versions/v0.1.0.rst diff --git a/docs/rst/notes/previous_versions/v0.1.0.rst b/docs/rst/notes/previous_versions/v0.1.0.rst new file mode 100644 index 00000000..fc97d37f --- /dev/null +++ b/docs/rst/notes/previous_versions/v0.1.0.rst @@ -0,0 +1,38 @@ +Version v0.1.0 +============== + +This is the first release of *eProsima Fast DDS Spy*. + +This release includes several **features** regarding the introspection of DDS data, configuration and user interaction. + +This release includes the following **User Interface features**: + +* :ref:`Application executable arguments `. +* :ref:`Interactive application `. +* :ref:`One-shot application `. + + +This release includes the following **Configuration features**: + +* Support :term:`YAML` :ref:`configuration file `. +* Support for allow and block topic filters at execution time and in run-time. +* Support :ref:`DDS configurations `. +* Support :ref:`Advanced configurations `. + + +This release includes the following **Introspection features**: + +* Get data of :term:`Domain Participants `. +* Get data of :term:`DataReaders ` and :term:`DataWriters `. +* Get data of :term:`Topics `. +* Print real-time DDS user data in human-readable format. + + +This release includes the following **Documentation features**: + +* This same documentation. + + +This release includes the following **Installation features**: + +* *Dockerfile* to build an image of the application ``Fast-DDS-Spy/docker``. diff --git a/docs/rst/spelling_wordlist.txt b/docs/rst/spelling_wordlist.txt index fba192d5..08581618 100644 --- a/docs/rst/spelling_wordlist.txt +++ b/docs/rst/spelling_wordlist.txt @@ -4,6 +4,7 @@ Asio blocklist Chocolatey CMake +colcon Colcon cpp dataflow