Skip to content

Commit 8c41f55

Browse files
authored
docs: document release process (#27)
Document release process in a separate file.
1 parent 29f81f1 commit 8c41f55

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

RELEASE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Release process
2+
===============
3+
4+
Create a pull request with a version bump to indicate the intention to do a release. This should give users the ability to give feedback, e.g. if a breaking change was missed and the version bump is incorrect.
5+
6+
Once that PR is merged do the actual release with [`cargo-release`](https://github.com/crate-ci/cargo-release).
7+
8+
This requires the following permissions
9+
10+
- on github.com/vmx/temp-env
11+
- creating tags
12+
- pushing to `main`
13+
- on crates.io
14+
- publish access to all published crates
15+
16+
Dry run
17+
18+
```console
19+
$ cargo release -vvv
20+
```
21+
22+
Actual publishing
23+
24+
```console
25+
$ cargo release --execute
26+
```

0 commit comments

Comments
 (0)