Skip to content

Commit

Permalink
Merge pull request #362 from Byron/maintenace-doc
Browse files Browse the repository at this point in the history
Add maintenance document
  • Loading branch information
Byron authored Aug 2, 2023
2 parents 5d462b3 + 02cd317 commit b1e993a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions MAINTENANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
This document explains how to perform the project's maintenance tasks.

### Creating a new release

#### Artifacts

* a tag of the version number
* a new [crate version](https://crates.io/crates/flate2/versions)

#### Process

To generate all the artifacts above, one proceeds as follows:

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.*
2. Edit `Cargo.toml` to the next package version.
3. `gh pr create` to create a new PR for the current branch and **get it merged**.
4. `cargo publish` to create a new release on `crates.io`.
5. `git tag <next-version>` to remember the commit.
6. `git push --tags` to push the new tag.
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.

0 comments on commit b1e993a

Please sign in to comment.