diff --git a/docs/releasing.md b/docs/releasing.md new file mode 100644 index 0000000..f8d7cb1 --- /dev/null +++ b/docs/releasing.md @@ -0,0 +1,16 @@ +# Release process + +1. `git checkout master && git pull` +2. `git checkout -b ` +3. Update the `version` field in `Cargo.toml`. +5. Update `CHANGELOG.md`. +6. Commit `Cargo.toml` and `CHANGELOG.md`. The commit message must start + with `release:`. +7. Push the branch and create a PR. +8. Merge the PR in "Rebase and merge" mode (to preserve the commit subject). + +After merging, the new release will automatically be created on +. A git tag will also be created automatically. + +See for more details of how the +release process is implemented.