-
Notifications
You must be signed in to change notification settings - Fork 21
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 "xtask changelog ci" to validate CHANGELOG.md files #584
Conversation
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.
Thanks! I've created a dev/changelog
branch for this work (making it the base branch). We can merge it at 2 different points in time:
- Once when we have the CI check (e.g.
xtask changelog ci
). - Once when we have
xtask changelog {major,minor,patch}
commands.
Next up is implement all the validation for 'ci'.
Last part is still WIP - refactor string parsing to be stateful instead of rough sting manipulation. |
This PR is ready for another pass. There is 1 validation missing: "The first version matches the Cargo.toml version." Will do that in follow up PR. |
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.
Thanks! Looks pretty good to me.
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.
Thanks! I've updated the branch to master and added a small commit with nits. I didn't review the changelog.rs file. I'll do that in the follow-up PRs. Also, we should have a PR before then that moves the module from xtask to cli-tools.
Diff will clean up after PR #584 is merged --------- Co-authored-by: Julien Cretin <[email protected]>
End goal (bug): Create script to automate updating CHANGELOG.md
This task will be done in 2 parts:
xtask changelog ci
: validates all CHANGELOG.md files <-- this PRxtask changelog {major,minor,patch}
: automatically updates changelogs with a new description.