-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Adoption of Changelog Enforcer GitHub Action in Autoware Repositories #4079
Comments
github-changelog-generatorThere is also an automated way of doing it using github-changelog-generator.
Github ReleasesThere is also Github Releases. I will investigate these options more and also share my findings. Please don't hesitate to add your inputs. Edit: semantic-releasehttps://github.com/semantic-release/semantic-release#-semantic-release
clerkThis is my favorite so far. 💖
Example Changelog: https://github.com/electron/electron/releases Example PR: electron/electron#40536 This looks like the best mix of automation and manual provision. The developers don't need to touch the CHANGELOG.md file. Developers just use the commit messages with the Conventional Commit style as usual and just add Release Notes section for each PR and rest is automated. |
https://github.com/googleapis/release-please#release-please
https://github.com/google-github-actions/release-please-action Example CHANGELOG: https://github.com/googleapis/gapic-generator/blob/master/CHANGELOG.md |
@xmfcx I strongly support this activity. Moreover, it should be linked with future releases of Autoware. One question: is it required to modify the changelog file in all PRs? Or, the changelog is updated automatically from the PR's description? |
@TakaHoribe thank you!
For the https://github.com/marketplace/actions/changelog-enforcer mentioned in the first issue, you must manually edit the changelog. But if we use https://github.com/googleapis/release-please#release-please then it is completely automated (from Commit Message. It generates ChangeLogs like this: https://github.com/googleapis/gapic-generator/blob/master/CHANGELOG.md release-please seems very popular and also maintained by Google(?) for now it is the most promising option. And it requires the least additional effort from the contributors. |
@xmfcx Interesting investigation! |
Checklist
Description
To improve the management and tracking of changes across the Autoware repositories, I propose the adoption of the Changelog Enforcer GitHub Action.
This action will ensure that every pull request includes a changelog update, helping us maintain a clear and consistent record of changes.
We will also enforce the https://keepachangelog.com/en/1.0.0/ format.
We aim to start this with the
autoware.universe
repository and, if successful, expand to other repositories likeautoware_launch
andautoware_msgs
.Purpose
The primary goals of implementing this action are:
Possible approaches
autoware.universe
, assess the effectiveness, and then proceed to other repositories.Definition of done
autoware.universe
repository.cc. @mitsudome-r @yukkysaito @isamu-takagi @TakaHoribe
The text was updated successfully, but these errors were encountered: