Skip to content

Commit 53bfb98

Browse files
committed
update based on feedback
Signed-off-by: Carlos Panato <[email protected]>
1 parent f6a735f commit 53bfb98

File tree

2 files changed

+25
-5
lines changed
  • keps/sig-release/2853-kubernetes-kubernetes-repository-branch-rename

2 files changed

+25
-5
lines changed

keps/sig-release/2853-kubernetes-kubernetes-repository-branch-rename/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ If none of those approvers are still appropriate, then changes to that list
5858
should be approved by the remaining approvers and/or the owning SIG (or
5959
SIG Architecture for cross-cutting KEPs).
6060
-->
61-
# KEP-NNNN: Your short, descriptive title
61+
# KEP-2853: Kubernetes repository branch rename
6262

6363
<!--
6464
This is the title of your KEP. Keep it short, simple, and descriptive. A good
@@ -89,6 +89,7 @@ tags, and then generate with `hack/update-toc.sh`.
8989
- [Notes/Constraints/Caveats (Optional)](#notesconstraintscaveats-optional)
9090
- [Risks and Mitigations](#risks-and-mitigations)
9191
- [Design Details](#design-details)
92+
- [Survey Questions](#survey-questions)
9293
- [Test Plan](#test-plan)
9394
- [Graduation Criteria](#graduation-criteria)
9495
- [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy)
@@ -170,7 +171,7 @@ updates.
170171
-->
171172

172173
Many communities, both on GitHub and in the wider Git community, are considering renaming the default branch name of their repository from `master`. The Kubernetes GitHub repositories is gradually renaming the default branch of our own repositories from `master` to `main`.
173-
This KEP is to we rename the branch for the main repository in the Kubernetes community.
174+
This KEP proposes that we rename the branch for the principal code repository in the Kubernetes project.
174175

175176
## Motivation
176177

@@ -218,9 +219,10 @@ implementation. What is the desired outcome and how do we measure success?.
218219
The "Design Details" section below is for the real
219220
nitty-gritty.
220221
-->
221-
- The change can be applied in the middle of December 2021. This is a good time because we will have less activity due to the Christmas and new year celebrations
222-
- Announce the change in the kubernetes-dev and kubernetes-announcement mailing list and maybe in a blog post. As well as use Twitter and other social media to announce.
223-
- Change all open Pull Requests to the `Draft mode` with that when we rename the branch, the tests will not be triggered and will avoid a massive queue in the CI infrastructure.
222+
- We aim to make the change during the start of v1.25 release (spring 2022).
223+
- Perform a Survey to gather information on downstream consumers and how this might affects their workflow. See [Survey Questions](#survey-questions).
224+
- Announce the change in the kubernetes-dev and kubernetes-announcement mailing list and in a blog post. As well as use Twitter and other social media to announce.
225+
- Change all open Pull Requests to `Draft mode` (so that when we rename the branch, tests will not be triggered, and we avoid a massive queue in the CI infrastructure).
224226
- Update all Prow jobs that use `kubernetes/kubernetes` and use the `master` branch to listen to the `main` branch as well
225227
- Follow the guide on https://github.com/kubernetes/community/blob/master/github-management/default-branch-migration.md to rename the repository branch name.
226228
- After the branch rename, announce that in the mailing list
@@ -244,6 +246,10 @@ Include as much detail as possible so that people can understand the "how" of
244246
the system. The goal here is to make this feel real for users without getting
245247
bogged down.
246248
-->
249+
As a contributor, I have to remember to use `master` when working with repositories that
250+
haven't yet switched.
251+
Switching k/k to `main` will reduce the burden slightly.
252+
247253

248254
#### Story 1
249255

@@ -280,6 +286,13 @@ change are understandable. This may include API specs (though not always
280286
required) or even code snippets. If there's any ambiguity about HOW your
281287
proposal will be implemented, this is the place to discuss them.
282288
-->
289+
#### Survey Questions
290+
291+
The survey we will send out to gether information from the downstream consumer will have the following questions:
292+
293+
1. On which companies behalf do you submit the response?
294+
2. Would a kubernetes/kubernetes branch rename affect your downstream workflow? If yes, how?
295+
3. How much time would you need in advance before the migration happens?
283296

284297
### Test Plan
285298

@@ -455,6 +468,10 @@ feature, can it break the existing applications?).
455468
NOTE: Also set `disable-supported` to `true` or `false` in `kep.yaml`.
456469
-->
457470

471+
Once we rename the branch from `master` to `main` GitHub offers the follow redirections.
472+
We don't have plans to switch back to the original name once that is renamed, and issues, if that appears,
473+
will be handled as an exception and as high priority.
474+
458475
###### What happens if we reenable the feature if it was previously rolled back?
459476

460477
###### Are there any tests for feature enablement/disablement?

keps/sig-release/2853-kubernetes-kubernetes-repository-branch-rename/kep.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ owning-sig: sig-release
66
participating-sigs:
77
- sig-release
88
- sig-security
9+
- sig-testing
10+
- sig-k8s-infra
11+
- sig-contribex
912
status: provisional
1013
creation-date: 2021-11-19
1114
reviewers:

0 commit comments

Comments
 (0)