From 895fd098ce0476a2dc39198f4d03ac90a92ea572 Mon Sep 17 00:00:00 2001 From: Christian Henkel <6976069+ct2034@users.noreply.github.com> Date: Thu, 27 Jun 2024 14:49:38 +0200 Subject: [PATCH] writing down the backport tool and its usage (#377) Signed-off-by: Christian Henkel (cherry picked from commit 0af0de12889f748cf9b29591a1a365ad5ac9eb82) --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index a17017fc..46509be6 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,22 @@ Diagnostics messages that are not aggregated can be visualized by [`rqt_runtime_ - **Iron Irwini** by the [`ros2-iron` branch](https://github.com/ros/diagnostics/tree/ros2-iron) - **Jazzy Jalisco** by the [`ros2-jazzy` branch](https://github.com/ros/diagnostics/tree/ros2-jazzy) +## Workflow + +New features are to be developed in custom branches and then merged into the `ros2` branch. + +From there, the changes are backported to the other branches. + +## Backport Tooling + +This tool has proven to be useful: [backport](https://www.npmjs.com/package/backport) + +Use this command to port a given PR of `PR_NUMBER` to the other branches: + +```bash +backport --pr PR_NUMBER -b ros2-humble ros2-iron ros2-jazzy +``` + # Versioning and Releases - (__X__.0.0) We use the major version number to indicate a breaking change.