Skip to content

Commit 74b3c73

Browse files
authored
Merge pull request #419 from Byron/maintenance-guide
update maintenance guide with recent news
2 parents dc6cab4 + af8bcdb commit 74b3c73

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

MAINTENANCE.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
This document explains how to perform the project's maintenance tasks.
22

3+
### Repository Configuration
4+
5+
Some repository settings, including branch protection and required approvals, are managed in the
6+
[Rust team repo](https://github.com/rust-lang/team/blob/master/repos/rust-lang/flate2-rs.toml).
7+
See the [repository schema](https://github.com/rust-lang/team/blob/aaa8039a2420a07cab9bbaca3885b3ad95a256a7/docs/toml-schema.md?plain=1#L248)
8+
for supported directives.
9+
310
### Creating a new release
411

512
#### Artifacts
@@ -11,11 +18,11 @@ This document explains how to perform the project's maintenance tasks.
1118

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

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**.
21+
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.*
22+
2. Edit `Cargo.toml` to update the package version to `<next-version>`.
23+
3. Create a new PR for the branch (e.g. using `gh pr create`) and **get it approved and merged**.
24+
4. Pull the `main` branch and ensure that you are at the merged commit.
1725
4. `cargo publish` to create a new release on `crates.io`.
1826
5. `git tag <next-version>` to remember the commit.
1927
6. `git push --tags` to push the new tag.
2028
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-

0 commit comments

Comments
 (0)