Skip to content

Commit dbe8c6a

Browse files
committed
devel/sig-release: Initial link cleanup
Signed-off-by: Stephen Augustus <[email protected]>
1 parent 4964c40 commit dbe8c6a

File tree

3 files changed

+43
-41
lines changed

3 files changed

+43
-41
lines changed

contributors/devel/sig-release/cherry-picks.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ branches.
1919
considered implicit for all code within cherry-pick pull requests,
2020
**unless there is a large conflict**.
2121
- A pull request merged against the master branch.
22-
- [Release branch](https://git.k8s.io/release/docs/branching.md) exists.
22+
- The release branch exists (example: [`release-1.18`](https://github.com/kubernetes/kubernetes/tree/release-1.18))
2323
- The normal git and GitHub configured shell environment for pushing to your
2424
kubernetes `origin` fork on GitHub and making a pull request against a
2525
configured remote `upstream` that tracks
@@ -71,22 +71,26 @@ continue, bolster your case by supplementing your PR with e.g.,
7171
## Initiate a Cherry-pick
7272

7373
- Run the [cherry-pick script](https://git.k8s.io/kubernetes/hack/cherry_pick_pull.sh)
74+
7475
This example applies a master branch PR #98765 to the remote branch
75-
`upstream/release-3.14`: `hack/cherry_pick_pull.sh upstream/release-3.14
76-
98765`
76+
`upstream/release-3.14`:
77+
78+
```shell
79+
hack/cherry_pick_pull.sh upstream/release-3.14 98765
80+
```
7781

7882
- Be aware the cherry-pick script assumes you have a git remote called
7983
`upstream` that points at the Kubernetes github org.
8084

81-
Please see our [recommended Git workflow](https://git.k8s.io/community/contributors/guide/github-workflow.md#workflow).
85+
Please see our [recommended Git workflow](/contributors/guide/github-workflow.md#workflow).
8286

8387
- You will need to run the cherry-pick script separately for each patch
8488
release you want to cherry-pick to.
8589

8690
- Your cherry-pick PR will immediately get the
8791
`do-not-merge/cherry-pick-not-approved` label.
8892

89-
[Normal rules apply for code merge](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-release/release.md#tldr),
93+
[Normal rules apply for code merge](/contributors/devel/sig-release/release.md#tldr),
9094
with some additional caveats outlined in the next section of this document.
9195

9296
## Cherry-pick Review
@@ -99,7 +103,7 @@ except the release note stanza will auto-populate from the master
99103
branch pull request from which the cherry-pick originated. If this
100104
is unsuccessful the `do-not-merge/release-note-label-needed` label
101105
will be applied and the cherry-pick author must edit the pull request
102-
description to [add a release note](https://git.k8s.io/community/contributors/guide/release-notes.md)
106+
description to [add a release note](/contributors/guide/release-notes.md)
103107
or include in a comment the `/release-note-none` command.
104108

105109
Cherry-pick pull requests are reviewed slightly differently than normal
@@ -114,15 +118,12 @@ pull requests on the master branch in that they:
114118
- Have one additional level of review in that they must be approved
115119
specifically for cherry-pick by branch approvers.
116120

117-
The [Branch Manager](https://git.k8s.io/sig-release/release-team/role-handbooks/branch-manager)
118-
will triage PRs targeted to the next .0 minor release branch up until the
119-
release, while the [Patch Release Team](https://git.k8s.io/sig-release/release-team/role-handbooks/patch-release-manager)
120-
will handle all cherry-picks to patch releases.
121+
The [Release Managers][release-managers] are the final approvers on release
122+
branches.
121123

122-
The [Branch Manager](https://git.k8s.io/sig-release/release-team/role-handbooks/branch-manager)
123-
or the [Patch Release Team](https://git.k8s.io/sig-release/release-team/role-handbooks/patch-release-manager)
124-
are the final authority on branch approval by removing the
125-
`do-not-merge/cherry-pick-not-approved` label and triggering a merge into the
124+
Approval is signified by a Release Manager manually applying the
125+
`cherry-pick-approved` label. This action removes the
126+
`do-not-merge/cherry-pick-not-approved` label and triggers a merge into the
126127
target branch.
127128

128129
The team scrubs through incoming cherry-picks on at least a weekly basis,
@@ -150,9 +151,10 @@ pull requests on the master branch in that they:
150151

151152
## Searching for Cherry-picks
152153

153-
- [A sample search on kubernetes/kubernetes pull requests that are labeled as `cherry-pick-approved`](https://github.com/kubernetes/kubernetes/pulls?q=is%3Aopen+is%3Apr+label%3Acherry-pick-approved)
154+
Examples (based on cherry picks targeting the `release-1.18` branch):
154155

155-
- [A sample search on kubernetes/kubernetes pull requests that are labeled as `do-not-merge/cherry-pick-not-approved`](https://github.com/kubernetes/kubernetes/pulls?q=is%3Aopen+is%3Apr+label%3Ado-not-merge%2Fcherry-pick-not-approved)
156+
- [`cherry-pick-approved`](https://github.com/kubernetes/kubernetes/pulls?q=is%3Aopen+is%3Apr+label%3Acherry-pick-approved+base%3Arelease-1.18)
157+
- [`do-not-merge/cherry-pick-not-approved`](https://github.com/kubernetes/kubernetes/pulls?q=is%3Aopen+is%3Apr+label%3Ado-not-merge%2Fcherry-pick-not-approved+base%3Arelease-1.18)
156158

157159
## Troubleshooting Cherry-picks
158160

@@ -177,7 +179,7 @@ longer supported.
177179
As discussed in a sig-release meeting on 2019-01-15, a fix was backported to
178180
the non supported version.
179181

180-
Reference PR: [#72860](https://github.com/kubernetes/kubernetes/pull/72860#issuecomment-454072746)
182+
Reference PR: [#72860](https://github.com/kubernetes/kubernetes/pull/72860)
181183

182184
The specific criteria driving the decision was:
183185

@@ -193,3 +195,5 @@ A note about the specific case in [#72860](https://github.com/kubernetes/kuberne
193195
- The patch was exceedingly tiny and very unlikely to introduce new problems
194196
- Luckily, it was caught shortly after the release was supposed to be
195197
unsupported
198+
199+
[release-managers]: https://git.k8s.io/sig-release/release-managers.md

contributors/devel/sig-release/getting-builds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting Kubernetes Builds
22

3-
You can use [hack/get-build.sh](http://releases.k8s.io/HEAD/hack/get-build.sh)
3+
You can use [hack/get-build.sh](https://git.k8s.io/kubernetes/hack/get-build.sh)
44
to get a build or to use as a reference on how to get the most recent builds
55
with curl. With `get-build.sh` you can grab the most recent stable build, the
66
most recent release candidate, or the most recent build to pass our ci and gce

contributors/devel/sig-release/release.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,13 @@ Return to 'Normal Dev' phase requirements:
6666
- /lgtm
6767
- /approved
6868

69-
Merges into the 1.y branch are now [via cherrypicks](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-release/cherry-picks.md),
69+
Merges into the 1.y branch are now [via cherry picks](/contributors/devel/sig-release/cherry-picks.md),
7070
approved by release branch manager.
7171

7272
In the past there was a requirement for a milestone targeted pull request to
7373
have an associated GitHub issue opened, but this is no longer the case.
74-
Features are effectively GitHub issues or [KEPs](https://git.k8s.io/community/keps)
75-
which lead to subsequent PRs. The general labeling process should be consistent
76-
across artifact types.
74+
Features are effectively GitHub issues or [KEPs][keps] which lead to subsequent
75+
PRs. The general labeling process should be consistent across artifact types.
7776

7877
---
7978

@@ -101,9 +100,9 @@ across artifact types.
101100
The process of removing an Enhancement from a release milestone if it is not
102101
fully implemented or is otherwise considered not stable.
103102
- *release milestone*: semantic version string or
104-
[GitHub milestone](https://help.github.com/articles/associating-milestones-with-issues-and-pull-requests/)
103+
[GitHub milestone](https://help.github.com/en/github/managing-your-work-on-github/associating-milestones-with-issues-and-pull-requests)
105104
referring to a release MAJOR.MINOR vX.Y version. See also
106-
[release versioning](http://git.k8s.io/community/contributors/design-proposals/release/versioning.md)
105+
[release versioning](/contributors/design-proposals/release/versioning.md)
107106
- *release branch*: Git branch "release-X.Y" created for the vX.Y milestone.
108107
Created at the time of the vX.Y-beta.0 release and maintained after the
109108
release for approximately 9 months with vX.Y.Z patch releases.
@@ -172,10 +171,7 @@ general development and work begins there for the next release milestone. Any
172171
remaining modifications for the current release are cherry picked from master
173172
back to the release branch. The release is built from the release branch.
174173

175-
Following release, the [Release Branch Manager](https://git.k8s.io/sig-release/release-team/role-handbooks/branch-manager/README.md)
176-
cherry picks additional critical fixes from the master branch for a period of
177-
around 9 months, leaving an overlap of three release versions forward support.
178-
Thus, each release is part of a broader Kubernetes lifecycle:
174+
Each release is part of a broader Kubernetes lifecycle:
179175

180176
![Image of Kubernetes release lifecycle spanning three releases](release-lifecycle.png)
181177

@@ -212,32 +208,31 @@ will be made by the release team through the following channels:
212208
the issue type
213209
- Emailing the SIG mailing list
214210
- bootstrapped with group email addresses from the
215-
[community sig list](/sig-list.md)
211+
[community sig list][sig-list]
216212
- optionally also directly addressing SIG leadership or other SIG members
217213
- Messaging the SIG's Slack channel
218214
- bootstrapped with the slackchannel and SIG leadership from the
219-
[community sig list](/sig-list.md)
215+
[community sig list][sig-list]
220216
- optionally directly "@" mentioning SIG leadership or others by handle
221217

222218
## Adding An Item To The Milestone
223219

224220
### Milestone Maintainers
225221

226-
The members of the GitHub
227-
[“kubernetes-milestone-maintainers” team](https://github.com/orgs/kubernetes/teams/kubernetes-milestone-maintainers/members)
228-
are entrusted with the responsibility of specifying the release milestone on
229-
GitHub artifacts. This group is [maintained by
230-
SIG Release](https://git.k8s.io/sig-release/release-team/README.md#milestone-maintainers)
231-
and has representation from the various SIGs' leadership.
222+
The members of the [`milestone-maintainers`](https://github.com/orgs/kubernetes/teams/milestone-maintainers/members)
223+
GitHub team are entrusted with the responsibility of specifying the release
224+
milestone on GitHub artifacts.
225+
226+
This group is [maintained](https://git.k8s.io/sig-release/release-team/README.md#milestone-maintainers)
227+
by SIG Release and has representation from the various SIGs' leadership.
232228

233229
### Feature additions
234230

235231
Feature planning and definition takes many forms today, but a typical example
236-
might be a large piece of work described in a
237-
[KEP](https://git.k8s.io/community/keps), with associated task issues in
238-
GitHub. When the plan has reached an implementable state and work is underway,
239-
the feature or parts thereof are targeted for an upcoming milestone by creating
240-
GitHub issues and marking them with the Prow "/milestone" command.
232+
might be a large piece of work described in a [KEP][keps], with associated task
233+
issues in GitHub. When the plan has reached an implementable state and work is
234+
underway, the feature or parts thereof are targeted for an upcoming milestone
235+
by creating GitHub issues and marking them with the Prow "/milestone" command.
241236

242237
For the first ~4 weeks into the release cycle, the release team's Enhancements
243238
Lead will interact with SIGs and feature owners via GitHub, Slack, and SIG
@@ -327,3 +322,6 @@ issue kind labels must be set:
327322
- `kind/failing-test`: CI test case is failing consistently.
328323
- `kind/feature`: New functionality.
329324
- `kind/flake`: CI test case is showing intermittent failures.
325+
326+
[keps]: https://git.k8s.io/enhancements/keps
327+
[sig-list]: /sig-list.md

0 commit comments

Comments
 (0)