From d2d9db35b444696245901007c8d9824037a90c9d Mon Sep 17 00:00:00 2001 From: Andrew Steurer <94206073+asteurer@users.noreply.github.com> Date: Mon, 6 Jul 2026 15:47:55 -0500 Subject: [PATCH] docs: document release process Signed-off-by: Andrew Steurer <94206073+asteurer@users.noreply.github.com> --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f0cbfa4..4da9746 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,3 +20,10 @@ See [LICENSE](LICENSE) for more details. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions. + +## Notes for Maintainers + +### Release process + +Bump the version field in [Cargo.toml](/Cargo.toml) and the release variable in [main.go](/main.go) (both should be the same), PR that into main, and tag the result. Once the tag has been pushed to main, the [release](/.github/workflows/release.yml) workflow will automatically create the release artifacts. +