add xtask changelog command.
#63
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a new `xtask changelog` command to `cargo xtask`, to help produce automated changelogs which can be the basis for updating `CHANGELOG.md`. This new command _does not_ overwrite `CHANGELOG.md`, but instead writes its auto-generated changelog to `CHANGELOG-NEXT.md`, which is also marked in `.gitignore` so it doesn't get checked in. The goal here is that this automation will _help_ write changelogs for each new version, but doesn't turn the changelog into a fully-automated system, as we still want to be able to have human-written release notes. Signed-off-by: Andrew Lilley Brinker <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 commit introduces a new
xtask changelogcommand tocargo xtask, to help produce automated changelogs which can be the basis for updatingCHANGELOG.md. This new command does not overwriteCHANGELOG.md, but instead writes its auto-generated changelog toCHANGELOG-NEXT.md, which is also marked in.gitignoreso it doesn't get checked in. The goal here is that this automation will help write changelogs for each new version, but doesn't turn the changelog into a fully-automated system, as we still want to be able to have human-written release notes.