Add Changelogs and bump version to 0.1.0 #21
Conversation
Signed-off-by: Yadunund <[email protected]>
Signed-off-by: Yadunund <[email protected]>
There was a problem hiding this comment.
Will the changelogs be auto generated? If so, we need a guideline on how to write commit messages. If not, we need a guideline on how to write the changelogs.
There was a problem hiding this comment.
These changelogs are generated using ros-infrastructure tooling such catkin_generate_changelogs and catkin_prepare_release (the latter will automatically bump pkg versions and update the changelog with the newly tagged version.
In the future when we run catkin_generate_changelogs, it will automatically populate the CHANGELOG.rst file with any new commits since the last tag and use the commit message as the description.
There was a problem hiding this comment.
Is there a REP on writing commit messages?
with any new commits since the last tag and use the commit message as the description
What if I have commits that does not deserve a change log? e.g. Updating github actions, cleanups etc.
There was a problem hiding this comment.
I don't think there is REP on writing commit messages as this is upto the discretion of the package maintainers across the community.
What if I have commits that does not deserve a change log? e.g. Updating github actions, cleanups etc.
It's totally upto the package maintainers whether to include these changes or not in the changelogs. To be clear you will not have to update the Changelog everytime a PR is merged. Periodically when we want to bump the version, we will run catkin_generate_changelogs and then we still have the freedom to modify/remove any entires the tool auto-populates before committing the changes. This how it is done for core ROS 2 pkgs.
There was a problem hiding this comment.
Fair enough, though imo this process can be improved. Most change log management tools analyzes commit messages to determine if they should be included in the changelogs, and what category is the change (bug fixes, new features). I thought the ROS tools would have commit message formats to support those things as well.
There was a problem hiding this comment.
Ah that would be a valuable addition to REP 132 which can motivate changes to catkin_generate_changelogs.
This PR adds Changelogs to all the pkgs here and bumps the versions to
0.1.0(0.0.1is reserved forhumbleversion of the pkgs).Once this PR is merged, I will tag the latest commit as
0.1.0.