From 9347eaecc3675191baa53bcb9207c71abb3b7dfe Mon Sep 17 00:00:00 2001 From: Camila Macedo Date: Thu, 18 Feb 2021 09:23:11 +0000 Subject: [PATCH] :book: suplememting info about release process --- RELEASE.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 40199f7018f..5eda684f2fe 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -2,19 +2,25 @@ The Kubebuilder Project is released on an as-needed basis. The process is as follows: -1. An issue is proposing a new release with a changelog since the last release +1. An issue is proposing a new release with a changelog since the last release. You will need to use the [kubebuilder-release-tools][kubebuilder-release-tools] to generate the notes. See [here][release-notes-generation] 1. All [OWNERS](OWNERS) must LGTM this release -1. An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION` -1. A PR needs to be created to merge `master` branch into `book-v2` to pick up the new docs. +1. An OWNER runs `git tag -s $VERSION` and pushes the tag with `git push $VERSION`. Note that after the OWNER push the tag the CI will automatically add the release notes and the assets. +1. A PR needs to be created to merge `release-X` branch into `book-vX` to pick up the new docs. 1. The release issue is closed 1. An announcement email is sent to `kubebuilder@googlegroups.com` with the subject `[ANNOUNCE] kubebuilder $VERSION is released` -Note: This process does not apply to EAP or alpha (pre-)releases which may be cut at any time for development +**Notes:** This process does not apply to EAP or alpha (pre-)releases which may be cut at any time for development and testing. +For further information about versioning and update the Kubebuilder binaries check the [versioning][release-process] doc. + ## HEAD releases The binaries releases for HEAD are available here: - [kubebuilder-release-master-head-darwin-amd64.tar.gz](https://storage.googleapis.com/kubebuilder-release/kubebuilder-release-master-head-darwin-amd64.tar.gz) - [kubebuilder-release-master-head-linux-amd64.tar.gz](https://storage.googleapis.com/kubebuilder-release/kubebuilder-release-master-head-linux-amd64.tar.gz) + +[kubebuilder-release-tools]: https://github.com/kubernetes-sigs/kubebuilder-release-tools +[release-notes-generation]: https://github.com/kubernetes-sigs/kubebuilder-release-tools/blob/master/README.md#release-notes-generation +[release-process]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/VERSIONING.md#releasing \ No newline at end of file