github/flagger
1
0
Fork 0
mirror of https://github.com/fluxcd/flagger.git synced 2026-04-15 06:57:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1324 from fluxcd/update-release-docs

Browse Source 
Update release docs
This commit is contained in:
Stefan Prodan
2022-11-23 17:14:13 +02:00
committed by GitHub
parent b0d9825afa 228fbeeda4
commit cbdc2c5a7c
1 changed files with 24 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/gitbook/dev/release-guide.md
+24 -4
View File
@@ -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/).