Skip to content

Commit 46079b3

Browse files
Document the release process
1 parent 3c63c8b commit 46079b3

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/releasing.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Release process
2+
3+
1. `git checkout master && git pull`
4+
2. `git checkout -b <some-branch-name>`
5+
3. Update the `version` field in `Cargo.toml`.
6+
5. Update `CHANGELOG.md`.
7+
6. Commit `Cargo.toml` and `CHANGELOG.md`. The commit message must start
8+
with `release:`.
9+
7. Push the branch and create a PR.
10+
8. Merge the PR in "Rebase and merge" mode (to preserve the commit subject).
11+
12+
After merging, the new release will automatically be created on
13+
<https://crates.io>. A git tag will also be created automatically.
14+
15+
See <https://crates.io/crates/auto-release> for more details of how the
16+
release process is implemented.

0 commit comments

Comments
 (0)