Skip to content

Commit 0675cd5

Browse files
authored
Merge pull request kubernetes-sigs#2030 from camilamacedo86/imp-release-docs
📖 adding info about the release process
2 parents de84b80 + 9347eae commit 0675cd5

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

RELEASE.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,25 @@
22

33
The Kubebuilder Project is released on an as-needed basis. The process is as follows:
44

5-
1. An issue is proposing a new release with a changelog since the last release
5+
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]
66
1. All [OWNERS](OWNERS) must LGTM this release
7-
1. An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION`
8-
1. A PR needs to be created to merge `master` branch into `book-v2` to pick up the new docs.
7+
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.
8+
1. A PR needs to be created to merge `release-X` branch into `book-vX` to pick up the new docs.
99
1. The release issue is closed
1010
1. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] kubebuilder $VERSION is released`
1111

12-
Note: This process does not apply to EAP or alpha (pre-)releases which may be cut at any time for development
12+
**Notes:** This process does not apply to EAP or alpha (pre-)releases which may be cut at any time for development
1313
and testing.
1414

15+
For further information about versioning and update the Kubebuilder binaries check the [versioning][release-process] doc.
16+
1517
## HEAD releases
1618

1719
The binaries releases for HEAD are available here:
1820

1921
- [kubebuilder-release-master-head-darwin-amd64.tar.gz](https://storage.googleapis.com/kubebuilder-release/kubebuilder-release-master-head-darwin-amd64.tar.gz)
2022
- [kubebuilder-release-master-head-linux-amd64.tar.gz](https://storage.googleapis.com/kubebuilder-release/kubebuilder-release-master-head-linux-amd64.tar.gz)
23+
24+
[kubebuilder-release-tools]: https://github.com/kubernetes-sigs/kubebuilder-release-tools
25+
[release-notes-generation]: https://github.com/kubernetes-sigs/kubebuilder-release-tools/blob/master/README.md#release-notes-generation
26+
[release-process]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/VERSIONING.md#releasing

0 commit comments

Comments
 (0)