Skip to content

Commit dabc20e

Browse files
authored
docs: release manual process (#100)
1 parent 57027b3 commit dabc20e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

release.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Creation of a new release
2+
3+
This is taking the 0.2.1 release as an example.
4+
5+
## GitHub stuff
6+
7+
- Checkout the prep-v0.2.1 branch
8+
- Update the release date in the changelog and push to the PR.
9+
- Squash merge the PR to the dev branch
10+
- Check that the merged PR is passing the tests on the dev branch
11+
- Pull the updated dev locally
12+
- Switch to the release branch
13+
- Merge locally dev into release in fast-forward mode, we want to keep the history of commits and the merge point.
14+
- `git tag -a v0.2.1 -m "v0.2.1: mostly perf improvements"`
15+
- (Optional) cryptographically sign the tag
16+
- On GitHub, edit the branch protection setting for release: uncheck include admin, and save
17+
- Push release to github: git push --follow-tags
18+
- Reset the release branch protection to include admins
19+
- On GitHub, create a release from that tag.
20+
21+
## Crates.io stuff
22+
23+
- `cargo publish --dry-run`
24+
- `cargo publish`
25+
26+
## Community stuff
27+
28+
Talk about the awesome new features of the new release online.

0 commit comments

Comments
 (0)