docs: document release process

This commit is contained in:
Hidde Beydals 2020-04-24 13:31:11 +02:00
parent 0fa698482a
commit 36e59f7aac
1 changed files with 13 additions and 0 deletions

13
docs/internal/release.md Normal file
View File

@ -0,0 +1,13 @@
# Release
To release a new version the following steps should be followed:
1. Create a new branch from `master` i.e. `release-<next semver>`. This
will function as your release preparation branch.
1. Add an entry to the `CHANGELOG.md` for the new release and change the
`newTag` value in ` config/manager/kustomization.yaml` to that of the
semver release you are going to make. Commit and push your changes.
1. Create a PR for your release branch and get it merged into `master`.
1. Create a `<next semver>` tag for the merge commit in `master` and
push it to remote.
1. Confirm CI builds and releases the newly tagged version.