Skip to content

Commit

Permalink
Merge pull request #2030 from camilamacedo86/imp-release-docs
Browse files Browse the repository at this point in the history
📖 adding info about the release process
  • Loading branch information
k8s-ci-robot authored Mar 10, 2021
2 parents de84b80 + 9347eae commit 0675cd5
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `[email protected]` 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

0 comments on commit 0675cd5

Please sign in to comment.