Sergey Konev
a8d83b9bab
Some checks failed
Continuous integration / Tests (push) Blocked by required conditions
Continuous integration / Tests (windows-latest) (push) Waiting to run
Continuous integration / Check clippy, formatting, and documentation (push) Failing after 20s
Continuous integration / Tests (ubuntu-latest) (push) Failing after 22s
Continuous integration / Check fuzzers (push) Failing after 18s
Continuous integration / Check mininum Rust version (push) Failing after 20s
1.3 KiB
1.3 KiB
This document explains how to perform the project's maintenance tasks.
Repository Configuration
Some repository settings, including branch protection and required approvals, are managed in the Rust team repo. See the repository schema for supported directives.
Creating a new release
Artifacts
- a tag of the version number
- a new crate version
Process
To generate all the artifacts above, one proceeds as follows:
git checkout -b release-<next-version>
- create a branch to make changes to the repository. Changes cannot be made tomain
as it is protected.- Edit
Cargo.toml
to update the package version to<next-version>
. - Create a new PR for the branch (e.g. using
gh pr create
) and get it approved and merged. - Pull the
main
branch and ensure that you are at the merged commit. cargo publish
to create a new release oncrates.io
.git tag <next-version>
to remember the commit.git push --tags
to push the new tag.- Go to the newly created release page on GitHub and edit it by pressing the "Generate Release Notes" and the
@
button. Save the release.