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 MR overhauls how the release process is handled.
We now leverage
release-plz
to handle crate releases and CHANGELOG generation.Proposed workflow.
release-pr
locally: this involves runningrelease-plz release-pr
locally with aGITHUB_TOKEN
(This action should ideally only be limited to repo maintainers). This should open a release PR with semver version bumps based on conventional commits prior to this PR viagit cliff
(handled automatically) byrelease-plz
git tag v*
locally and push the tag.release-plz
.crates.io
and run other workflows i.e update gh pages docs.Caveats
release-plz
assumes the repository follows conventional commits in order to determine whether apatch
,minor
ormajor
bump is required, as well as to generate changelog content. Conventional commits are currently not enforced for this repo, we will therefore need to adopt them to allow for seamless releases. TheCONTRIBUTING.md
guide has been updated with this info.1.2.0
? We will skip step 1 (Initializerelease-pr
locally) of the proposed workflow since there are no historical conventional commits forrelease-plz
to generate a CHANGELOG and bump version from.