Skip to content

Commit

Permalink
Use a single file for migration + release notes (#324)
Browse files Browse the repository at this point in the history
* Use a single file for migration + release notes

* Remove hardcoded distro

* Add another note

(cherry picked from commit 698e41f)

# Conflicts:
#	doc/migration/migration.rst
#	doc/release_notes/release_notes.rst
  • Loading branch information
christophfroehlich authored and mergify[bot] committed Jul 14, 2024
1 parent 61c9c1f commit 5919b55
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
13 changes: 11 additions & 2 deletions doc/migration/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,26 @@ Coming from ros_control (ROS 1)
Between different ROS 2 distributions
**************************************

<<<<<<< HEAD
=======
This list summarizes necessary changes to your code for a version update to {DISTRO}. If you are skipping a distribution update, make sure to read the migration guides of all intermediate distributions.

For non-breaking updates, see the :ref:`release_notes`.
>>>>>>> 698e41f (Use a single file for migration + release notes (#324))

ros2_control
-------------

.. toctree::
:titlesonly:

<<<<<<< HEAD
Foxy to Galactic <../ros2_control/doc/migration/Galactic.rst>


ros2_controllers
----------------

There are no migration notes yet.
=======
ros2_control <../ros2_control/doc/migration.rst>
ros2_controllers <../ros2_controllers/doc/migration.rst>
>>>>>>> 698e41f (Use a single file for migration + release notes (#324))
17 changes: 17 additions & 0 deletions doc/release_notes/release_notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _release_notes:

Release Notes
=================================

This page should highlight the most important changes of the ros2_control framework in the {DISTRO} release. If you are skipping a distribution update, make sure to read the release notes of all intermediate distributions.

These lists might not be complete, see the ``CHANGELOG.rst`` files in the respective repositories for a full list of changes.

For necessary changes to your code for a version update, see the :ref:`migration`.


.. toctree::
:titlesonly:

ros2_control <../ros2_control/doc/release_notes.rst>
ros2_controllers <../ros2_controllers/doc/release_notes.rst>

0 comments on commit 5919b55

Please sign in to comment.