Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Changelogs and bump version to 0.1.0 #21
Add Changelogs and bump version to 0.1.0 #21
Changes from all commits
6b57f23
38579a1
1c2cc71
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changelogs are generated using ros-infrastructure tooling such
catkin_generate_changelogs
andcatkin_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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a REP on writing commit messages?
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think there is REP on writing commit messages as this is upto the discretion of the package maintainers across the community.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah that would be a valuable addition to REP 132 which can motivate changes to
catkin_generate_changelogs
.