Repository navigation
chore: add a changelog and the cargo-release changelog hook - #111
Merged
Merged
Conversation
Changelog entries are generated with git-cliff from conventional commits from now on, like in iroh-blobs. The entries since 0.16.1 are written by hand, and the hook adds the 0.17.0 heading with the release date.
This file contains hidden or 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
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.
Adds the changelog machinery from iroh-blobs, so releases are done with cargo-release and git-cliff.
cliff.tomlis the iroh-blobs config for this repo. Commits from now on should follow the conventional commits format.[package.metadata.release]runs git-cliff as pre-release hook. It passes--tag v{{version}}, so the compare link uses the real tag name.CHANGELOG.mdhas hand written entries for everything since 0.16.1, since those commits are not conventional. It has no version heading on purpose: the hook adds## [0.17.0](…) - <date>on release.cliff.tomlskips ci(secruity): hardening + lock files + dependabot cooldown #86, the only old commit that parses as conventional, so it does not show up twice.Note that
cargo releasein dry-run mode still runs the hook, which writes to CHANGELOG.md.