Synchronize GitHub Releases with the in-repo changelog #811
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.
This PR adds a new handler to triagebot that synchronizes the GitHub Releases with the changelog present inside a repository itself. It's meant to be used for rustc, but it's designed to be easily extensible. Namely, I want to implement support for keep a changelog to synchronize rustwide's changelog in a future PR.
The handler can be enabled by adding this snippet to a
triagebot.toml
:The handler will run when either a new tag is pushed, or when a new commit on the
changelog-branch
branch is pushed. It will create releases named"{project-name} {tag}"
with the relevant section of the changelog as their body. It will also automatically update old releases if the changelog was updated after the fact.The only supported format right now is
rustc
, which maps to rustc's RELEASES.md file. It's possible to add new formats by changing thesrc/changelogs/
module, so this handle can be used for other Rust projects too.You can see the result of running this in my fork of rustc.
This PR is best reviewed commit-by-commit.
r? @Mark-Simulacrum