Skip to content

Commit 9a65859

Browse files
committed
Contrib: Document new-release process
1 parent 281989f commit 9a65859

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/doc/contrib/src/process/release.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,23 @@ release**. It is rare that these get updated. Bumping these as-needed helps
5353
avoid churning incompatible version numbers. This process should be improved
5454
in the future!
5555

56+
[@ehuss] has a tool called [cargo-new-release] to automate the process of doing a version bump.
57+
It runs through several steps:
58+
1. Creates a branch
59+
2. Updates the version numbers
60+
3. Creates a changelog for anything on the master branch that is not part of beta
61+
4. Creates a changelog for anything on the beta branch
62+
63+
It opens a browser tab for every PR in order to review each change.
64+
It places each PR in the changelog with its title, but usually every PR should be rewritten to explain the change from the user's perspective.
65+
Each PR should also be categorized as an Addition, Change, Fix, or Nightly-only change.
66+
Most PRs are deleted, since they are not relevant to users of Cargo.
67+
For example, remove all PRs related to Cargo internals, infrastructure, documentation, error changes, refactorings, etc.
68+
Usually about half of the PRs get removed.
69+
This process usually takes @ehuss about an hour to finish.
70+
71+
[@ehuss]: https://github.com/ehuss/
72+
[cargo-new-release]: https://github.com/ehuss/cargo-new-release
5673
[`crates/` directory]: https://github.com/rust-lang/cargo/tree/master/crates
5774

5875
## Docs publishing

0 commit comments

Comments
 (0)