Skip to content

Commit de56074

Browse files
committed
Auto merge of #418 - kamalmarhubi:release-procedure, r=posborne
Expand on release procedure
2 parents 3612b35 + 8557e9f commit de56074

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

RELEASE_PROCEDURE.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,36 @@ library.
33

44
# Before Release
55

6-
The release is prepared by a commit with the following changes.
6+
Based on changes since the last release, pick a new version number
7+
following semver conventions. For nix, a change that drops support for
8+
some Rust versions counts as a breaking change, and requires a major bump.
79

8-
- In CHANGELOG.md, rename the Unreleased section to the new version followed by
9-
the date of the release.
10+
The release is prepared as follows:
11+
12+
- Make a commit with a message like "Release v0.8.3" with the following
13+
changes:
14+
- In `CHANGELOG.md`, rename the Unreleased section to the new version
15+
followed by the date of the release.
16+
- In `Cargo.toml`, update the version to the new version.
17+
- In `README.md`, update the version in the Usage section to the new
18+
version.
19+
- Make a pull request.
20+
- Once the PR is merged, tag the merge commit, eg `git tag v0.8.3
21+
$MERGE_COMMIT_SHA1`.
22+
- Push the tag, eg `git push v0.8.3`.
1023

1124
# Create Release
1225

26+
- Checkout the tag.
27+
- Publish to crates.io with `cargo publish`.
28+
1329
# After Release
1430

1531
After the release a commit with the following changes is added to the master
1632
branch.
1733

1834
- Add a new Unreleased section header to CHANGELOG.md.
35+
- In `Cargo.toml`, update the version to the next `-dev` version, eg
36+
`v0.8.4-dev`.
37+
- Commit with a message like "Bump to v0.8.4-dev"
38+
- Make a pull request.

0 commit comments

Comments
 (0)