another-boids-in-rust/vendor/flate2/MAINTENANCE.md

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:

1. git checkout -b release-<next-version> - create a branch to make changes to the repository. Changes cannot be made to main as it is protected.
2. Edit Cargo.toml to update the package version to <next-version>.
3. Create a new PR for the branch (e.g. using gh pr create) and get it approved and merged.
4. Pull the main branch and ensure that you are at the merged commit.
5. cargo publish to create a new release on crates.io.
6. git tag <next-version> to remember the commit.
7. git push --tags to push the new tag.
8. Go to the newly created release page on GitHub and edit it by pressing the "Generate Release Notes" and the @ button. Save the release.