Skip to content

Commit de345ff

Browse files
authored
writing down the backport tool and its usage (#377) (#380)
Signed-off-by: Christian Henkel <[email protected]> (cherry picked from commit 0af0de1)
1 parent 0e18035 commit de345ff

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,22 @@ Diagnostics messages that are not aggregated can be visualized by [`rqt_runtime_
3939
- **Iron Irwini** by the [`ros2-iron` branch](https://github.com/ros/diagnostics/tree/ros2-iron)
4040
- **Jazzy Jalisco** by the [`ros2-jazzy` branch](https://github.com/ros/diagnostics/tree/ros2-jazzy)
4141

42+
## Workflow
43+
44+
New features are to be developed in custom branches and then merged into the `ros2` branch.
45+
46+
From there, the changes are backported to the other branches.
47+
48+
## Backport Tooling
49+
50+
This tool has proven to be useful: [backport](https://www.npmjs.com/package/backport)
51+
52+
Use this command to port a given PR of `PR_NUMBER` to the other branches:
53+
54+
```bash
55+
backport --pr PR_NUMBER -b ros2-humble ros2-iron ros2-jazzy
56+
```
57+
4258
# Versioning and Releases
4359

4460
- (__X__.0.0) We use the major version number to indicate a breaking change.

0 commit comments

Comments
 (0)