From 0617db7aa53b57d4949bc99972350012cd216bc3 Mon Sep 17 00:00:00 2001 From: Narthana Epa Date: Wed, 13 Mar 2024 11:25:59 +1100 Subject: [PATCH] Add release steps to DEVELOPMENT.md --- DEVELOPMENT.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index cd6a79fe..c5cf1071 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -96,3 +96,23 @@ config: ``` The `config` key contains configuration passed directly to the binary, and so supports all the keys documented in [the example](examples/config.yaml). + +# Release +1. Make sure you're on the main branch! +1. Create a tag +```bash +git -sm v0.x.x v0.x.x +``` +1. Push your tag +```bash +git push --tags +``` +1. A build will start at https://buildkite.com/buildkite-kubernetes-stack/kubernetes-agent-stack/builds?branch=v0.x.x. It will create a draft release with a changelog. Edit the changelog to group the PRs in to sections like +``` +# Added +# Fixed +# Changed +# Security +# Internal +``` +1. Publish the release 🎉