Skip to content

Commit 60cbe44

Browse files
fjpfjp
authored
Update diffbot_robot.md
Update instructions on how to prepare and release a package
1 parent e24193d commit 60cbe44

File tree

1 file changed

+108
-2
lines changed

1 file changed

+108
-2
lines changed

Diff for: ‎docs/diffbot_robot.md

+108-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## DiffBot Robot
1+
# DiffBot Robot
22

33
The [`diffbot_robot`](https://github.com/ros-mobile-robots/diffbot/tree/noetic-devel/diffbot_robot) package is a
44
[ROS metapackage](http://wiki.ros.org/Metapackages) that references all related packages to DiffBot.
@@ -14,6 +14,112 @@ Successfully created files in /home/fjp/git/ros_ws/src/diffbot/diffbot_robot. Pl
1414
To release a package see the [bloom](http://wiki.ros.org/bloom) page and the listed tutorials there. Specifically the following ones:
1515

1616
- To index the package follow the [Indexing Your ROS Repository for Documentation Generation](http://wiki.ros.org/rosdistro/Tutorials/Indexing%20Your%20ROS%20Repository%20for%20Documentation%20Generation).
17-
1817
- Release a package using bloom, see [First Time Release tutorial](http://wiki.ros.org/bloom/Tutorials/FirstTimeRelease).
1918

19+
## Prepare and Create a New Release
20+
21+
The steps to do create a new release are the following
22+
23+
1. `cd` to the `diffbot` repository which contains all the modified packages and make sure there are no uncommitted or untracked changes.
24+
2. Use `catkin_generate_changelog` to create updated changelogs (populated with the previous commit messages):
25+
26+
```console
27+
➜ diffbot git:(noetic-devel) ✗ catkin_generate_changelog
28+
Found packages: diffbot_base, diffbot_bringup, diffbot_control, diffbot_description, diffbot_gazebo, diffbot_mbf, diffbot_msgs, diffbot_navigation, diffbot_robot, diffbot_slam
29+
Querying commit information since latest tag...
30+
Updating forthcoming section of changelog files...
31+
- updating 'diffbot_base/CHANGELOG.rst'
32+
- updating 'diffbot_bringup/CHANGELOG.rst'
33+
- updating 'diffbot_control/CHANGELOG.rst'
34+
- updating 'diffbot_description/CHANGELOG.rst'
35+
- updating 'diffbot_gazebo/CHANGELOG.rst'
36+
- updating 'diffbot_mbf/CHANGELOG.rst'
37+
- updating 'diffbot_msgs/CHANGELOG.rst'
38+
- updating 'diffbot_navigation/CHANGELOG.rst'
39+
- updating 'diffbot_robot/CHANGELOG.rst'
40+
- updating 'diffbot_slam/CHANGELOG.rst'
41+
Done.
42+
Please review the extracted commit messages and consolidate the changelog entries before committing the files!
43+
```
44+
3. Clean up the Changelog: Go through every package's CHANGELOG.rst file and modify the commit messages if needed.
45+
4. Commit the updated CHANGELOG.rst files
46+
47+
```console
48+
➜ diffbot git:(noetic-devel) ✗ git status
49+
On branch noetic-devel
50+
Your branch is up to date with 'origin/noetic-devel'.
51+
52+
Changes not staged for commit:
53+
(use "git add <file>..." to update what will be committed)
54+
(use "git restore <file>..." to discard changes in working directory)
55+
modified: diffbot_base/CHANGELOG.rst
56+
modified: diffbot_bringup/CHANGELOG.rst
57+
modified: diffbot_control/CHANGELOG.rst
58+
modified: diffbot_description/CHANGELOG.rst
59+
modified: diffbot_gazebo/CHANGELOG.rst
60+
modified: diffbot_mbf/CHANGELOG.rst
61+
modified: diffbot_msgs/CHANGELOG.rst
62+
modified: diffbot_navigation/CHANGELOG.rst
63+
modified: diffbot_robot/CHANGELOG.rst
64+
modified: diffbot_slam/CHANGELOG.rst
65+
66+
no changes added to commit (use "git add" and/or "git commit -a")
67+
➜ diffbot git:(noetic-devel) ✗ git add .
68+
➜ diffbot git:(noetic-devel) ✗ git status
69+
On branch noetic-devel
70+
Your branch is up to date with 'origin/noetic-devel'.
71+
72+
Changes to be committed:
73+
(use "git restore --staged <file>..." to unstage)
74+
modified: diffbot_base/CHANGELOG.rst
75+
modified: diffbot_bringup/CHANGELOG.rst
76+
modified: diffbot_control/CHANGELOG.rst
77+
modified: diffbot_description/CHANGELOG.rst
78+
modified: diffbot_gazebo/CHANGELOG.rst
79+
modified: diffbot_mbf/CHANGELOG.rst
80+
modified: diffbot_msgs/CHANGELOG.rst
81+
modified: diffbot_navigation/CHANGELOG.rst
82+
modified: diffbot_robot/CHANGELOG.rst
83+
modified: diffbot_slam/CHANGELOG.rst
84+
➜ diffbot git:(noetic-devel) ✗ git commit -m "prepare release: updating CHANGELOG.rst files"
85+
[noetic-devel d2849d9] prepare release: updating CHANGELOG.rst files
86+
10 files changed, 70 insertions(+)
87+
```
88+
5. Bump up the package.xml version
89+
90+
```console
91+
➜ diffbot git:(noetic-devel) catkin_prepare_release --bump minor
92+
Prepare the source repository for a release.
93+
Repository type: git
94+
Found packages: diffbot_base, diffbot_bringup, diffbot_control, diffbot_description, diffbot_gazebo, diffbot_mbf, diffbot_msgs, diffbot_navigation, diffbot_robot, diffbot_slam
95+
Prepare release of version '1.1.0' [Y/n]?
96+
Trying to push to remote repository (dry run)...
97+
Everything up-to-date
98+
Checking if working copy is clean (no staged changes, no modified files, no untracked files)...
99+
Rename the forthcoming section of the following packages to version '1.1.0': diffbot_base, diffbot_bringup, diffbot_control, diffbot_description, diffbot_gazebo, diffbot_mbf, diffbot_msgs, diffbot_navigation, diffbot_robot, diffbot_slam
100+
Bump version of all packages from '1.0.0' to '1.1.0'
101+
Committing the package.xml files...
102+
[noetic-devel e7b6c8c] 1.1.0
103+
20 files changed, 30 insertions(+), 30 deletions(-)
104+
Creating tag '1.1.0'...
105+
The following commands will be executed to push the changes and tag to the remote repository:
106+
/usr/bin/git push origin noetic-devel
107+
/usr/bin/git push origin 1.1.0
108+
Execute commands to push the local commits and tags to the remote repository [Y/n]?
109+
Enumerating objects: 54, done.
110+
Counting objects: 100% (54/54), done.
111+
Delta compression using up to 48 threads
112+
Compressing objects: 100% (32/32), done.
113+
Writing objects: 100% (32/32), 5.78 KiB | 227.00 KiB/s, done.
114+
Total 32 (delta 24), reused 0 (delta 0)
115+
remote: Resolving deltas: 100% (24/24), completed with 21 local objects.
116+
To https://github.com/ros-mobile-robots/diffbot.git
117+
d2849d9..e7b6c8c noetic-devel -> noetic-devel
118+
Total 0 (delta 0), reused 0 (delta 0)
119+
To https://github.com/ros-mobile-robots/diffbot.git
120+
* [new tag] 1.1.0 -> 1.1.0
121+
The source repository has been released successfully. The next step will be 'bloom-release'.
122+
```
123+
124+
As mentioned in the final output, you are now ready to create a [release repository](http://wiki.ros.org/bloom/Tutorials/FirstTimeRelease#Creating_a_Release_Repository) (if not already [done](https://github.com/ros-mobile-robots-release))) and
125+
follow the rest of the steps to [releasing your package](http://wiki.ros.org/bloom/Tutorials/FirstTimeRelease#Creating_a_Release_Repository).

0 commit comments

Comments
 (0)