diff --git a/docs/internal/release.md b/docs/internal/release.md new file mode 100644 index 00000000..a3ed9a7c --- /dev/null +++ b/docs/internal/release.md @@ -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-`. 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 `` tag for the merge commit in `master` and + push it to remote. +1. Confirm CI builds and releases the newly tagged version.