Skip to content

Commit fb88fd6

Browse files
committed
📖 Clean up VERSIONING.md
There was a typo in the release steps section, plus a clarification needed around separately annotated commits.
1 parent 1935f65 commit fb88fd6

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

VERSIONING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ to match the PR. For instance, if you have a bugfix in with a breaking
100100
change, it's generally encouraged to submit the bugfix separately, but if
101101
you must put them in one PR, mark the commit separately.
102102

103+
*Commits marked separately will be treated similiarly to a distinct PR by
104+
the cherrypick scripts*. Therefore, only use them if you want the given
105+
commit to be considered separately.
106+
103107
### Commands and Workflow
104108

105109
controller-runtime follows the standard Kubernetes workflow: any PR needs
@@ -126,17 +130,15 @@ will evaluate when to do a major release as it comes up.
126130

127131
### Exact Steps
128132

129-
1. Generate release notes using the release note tooling (***TODO***)
130-
131-
2. Add a release for controller-runtime on GitHub, using those release
132-
notes
133+
1. (*if doing a minor or patch release*) Update the release-X branch with
134+
the latest set of changes using the cherrypick tooling (***TODO***)
133135

134-
3. Add a release for controller-tools on GitHub (folowing a similar
135-
process for controller-tools release notes).
136+
2. Generate release notes using the release note tooling (***TODO***)
136137

137-
4. Publish associated binaries and release tarballs (***TODO***)
138+
3. Add a release for controller-runtime on GitHub, using those release
139+
notes, with a title of `vX.Y.Z`.
138140

139-
5. Announce the release in `#kubebuilder` on Slack with a pinned message.
141+
4. Announce the release in `#kubebuilder` on Slack with a pinned message.
140142

141143
### Breaking Changes
142144

0 commit comments

Comments
 (0)