From 228fbeeda4a75fda691d7c5e5d633992d5644bd9 Mon Sep 17 00:00:00 2001 From: Stefan Prodan Date: Wed, 23 Nov 2022 16:40:46 +0200 Subject: [PATCH] Update release docs Signed-off-by: Stefan Prodan --- docs/gitbook/dev/release-guide.md | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/docs/gitbook/dev/release-guide.md b/docs/gitbook/dev/release-guide.md index d7a7bf15..8aa5149a 100644 --- a/docs/gitbook/dev/release-guide.md +++ b/docs/gitbook/dev/release-guide.md @@ -4,13 +4,28 @@ This document describes how to release Flagger. ## Release +### Flagger + To release a new Flagger version (e.g. `2.0.0`) follow these steps: -* create a branch `git checkout -b prep-2.0.0` +* create a branch `git checkout -b release-2.0.0` * set the version in code and manifests `TAG=2.0.0 make version-set` * commit changes and merge PR -* checkout master `git checkout main && git pull` -* tag master `make release` +* checkout main `git checkout main && git pull` +* tag main `make release` + +### Flagger load tester + +To release a new Flagger load tester version (e.g. `2.0.0`) follow these steps: + +* create a branch `git checkout -b release-ld-2.0.0` +* set the version in code (`cmd/loadtester/main.go#VERSION`) +* set the version in the Helm chart (`charts/loadtester/Chart.yaml` and `values.yaml`) +* set the version in manifests (`kustomize/tester/deployment.yaml`) +* commit changes and push the branch upstream +* in GitHub UI, navigate to Actions and run the `push-ld` workflow selecting the release branch +* after the workflow finishes, open the PR which will run the e2e tests using the new tester version +* merge the PR if the tests pass ## CI @@ -18,7 +33,9 @@ After the tag has been pushed to GitHub, the CI release pipeline does the follow * creates a GitHub release * pushes the Flagger binary and change log to GitHub release -* pushes the Flagger container image to Docker Hub +* pushes the Flagger container image to GitHub Container Registry +* pushed the Flagger install manifests to GitHub Container Registry +* signs all OCI artifacts and release assets with Cosign and GitHub OIDC * pushes the Helm chart to github-pages branch * GitHub pages publishes the new chart version on the Helm repository @@ -32,3 +49,6 @@ After a Flagger release, publish the docs with: * `git checkout docs` * `git rebase main` * `git push origin docs` + +Lastly open a PR with all the docs changes on [fluxcd/website](https://github.com/fluxcd/website) to +update [fluxcd.io/flagger](https://fluxcd.io/flagger/).