vendor/flate2/MAINTENANCE.md

   1 This document explains how to perform the project's maintenance tasks.
   2
   3 ### Creating a new release
   4
   5 #### Artifacts
   6
   7 * a tag of the version number
   8 * a new [crate version](https://crates.io/crates/flate2/versions)
   9
  10 #### Process
  11
  12 To generate all the artifacts above, one proceeds as follows:
  13
  14 1. `git checkout -b release-<next-version>` - move to a branch to prepare making changes to the repository. *Changes cannot be made to `main` as it is protected.*
  15 2. Edit `Cargo.toml` to the next package version.
  16 3. `gh pr create` to create a new PR for the current branch and **get it merged**.
  17 4. `cargo publish` to create a new release on `crates.io`.
  18 5. `git tag <next-version>` to remember the commit.
  19 6. `git push --tags` to push the new tag.
  20 7. Go to the newly created release page on GitHub and edit it by pressing the "Generate Release Notes" and the `@` button. Save the release.
  21