From 7c371d2366a64ec3955d0fd26ee3d13751899942 Mon Sep 17 00:00:00 2001 From: Davis Vaughan Date: Wed, 27 Nov 2024 12:52:49 -0500 Subject: [PATCH] Add simple release docs --- docs/release.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/release.md diff --git a/docs/release.md b/docs/release.md new file mode 100644 index 00000000..11e70577 --- /dev/null +++ b/docs/release.md @@ -0,0 +1,27 @@ +# CLI + +The release process of the air cli has some manual steps. When you want to cut a release: + +- Create a release branch + + - In `crates/air/Cargo.toml`, bump the version. + + - Run `cargo check` to sync `Cargo.lock`. + + - Do a PR and merge the release branch. + +- Manually run the [release workflow](https://github.com/posit-dev/air/actions/workflows/release.yml) + + - It runs on `workflow_dispatch`, and you must provide the `Release Tag` version to create. Always provide the same version that you used in `Cargo.toml`. Do not prefix the version with a `v`. + + - The release workflow will: + + - Build the binaries and installer scripts. + + - Create and push a git tag for the version. + + - Create a GitHub Release attached to that git tag. + + - Attach the binaries and scripts to that GitHub Release as artifacts. + +There is no need to bump to an intermediate "dev version" after a release.