Introduce a changelog with cargo changelog
#354
Closed
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 is a proposal for maintaining a changelog, which currently does not exist.
The way this works is to use conventional commits only when those notes should
appear in the changelog next time it is updated with
cargo changelog
orcargo smart-release
.This way, useful changelog can be generated with minimal effort, while making it possible to
hand-write portions of it as one sees fit.
I am using this system to maintain changelogs for more than 40 interconnected crates over at
gitoxide
, and without it I would definitely have lost my sanity already.With that said, I understand that this might be a complicated topic and if there is any hestancy
there is certainly no issue to continue without a changelog as well.
CHANGELOG.md rendered
MAINTENANCE.md rendered