diff options
Diffstat (limited to '')
| -rw-r--r-- | third_party/rust/prio/documentation/releases.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/third_party/rust/prio/documentation/releases.md b/third_party/rust/prio/documentation/releases.md new file mode 100644 index 0000000000..db0b4c246f --- /dev/null +++ b/third_party/rust/prio/documentation/releases.md @@ -0,0 +1,13 @@ +# Releases + +We use a GitHub Action to publish a crate named `prio` to [crates.io](https://crates.io). To cut a +release and publish: + +- Bump the version number in `Cargo.toml` to e.g. `1.2.3` and merge that change to `main` +- Tag that commit on main as `v1.2.3`, either in `git` or in [GitHub's releases UI][releases]. +- Publish a release in [GitHub's releases UI][releases]. + +Publishing the release will automatically publish the updated [`prio` crate][crate]. + +[releases]: https://github.com/divviup/libprio-rs/releases/new +[crate]: https://crates.io/crates/prio |