Skip to content

Commit

Permalink
docs: document release process (#27)
Browse files Browse the repository at this point in the history
Document release process in a separate file.
  • Loading branch information
vmx authored Dec 4, 2024
1 parent 29f81f1 commit 8c41f55
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Release process
===============

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.

Once that PR is merged do the actual release with [`cargo-release`](https://github.com/crate-ci/cargo-release).

This requires the following permissions

- on github.com/vmx/temp-env
- creating tags
- pushing to `main`
- on crates.io
- publish access to all published crates

Dry run

```console
$ cargo release -vvv
```

Actual publishing

```console
$ cargo release --execute
```

0 comments on commit 8c41f55

Please sign in to comment.