-
Notifications
You must be signed in to change notification settings - Fork 161
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #362 from Byron/maintenace-doc
Add maintenance document
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|