Default branch migration docs feedback

[nikhita]

This issue is to track feedback about docs for migrating default branch from master to main. Docs are at:

• https://k8s.dev/rename
• https://github.com/kubernetes/community/blob/master/github-management/default-branch-migration.md

We've had feedback and ideas being shared in slack. This issue would help in collecting the feedback at a single place on GitHub.

Note - The docs are meant for repos who would like to try out default branch migration and provide feedback. There are a few outstanding items we'd like to complete (tracked in kubernetes/org#2222) before announcing the docs more broadly.

cc @spiffxp @mrbobbytables @cblecker

/sig contributor-experience
/area github-management

[nikhita]

Feedback from @BenTheElder (ref: slack thread):

bentheelder:dns:  5 days ago
first thing that comes up is under prerequesites it says:
Create an issue in your repo to track the branch rename. You can paste this checklist in the issue body.
Except you can't really copy and paste a checklist this from the page, and I haven't spotted the page source from the page (I'm sure I can find it, but it doesn't seem obvious) (edited) 

bentheelder:dns:  5 days ago
I think maybe instead we should consider linking to an issue template and encourage the template / checklist more strongly?

bentheelder:dns:  5 days ago
  Once the issue has been approved, send a notice to your SIG’s mailing list about the potential branch rename.

bentheelder:dns:  5 days ago
I understand the sentiment warning people, but are we sure we want an email per repo?
I think this is potentially trollbait and going to get a bit noisy as we ramp this up, versus active contributors can see the repo issue etc?

bentheelder:dns:  5 days ago
(especially for repos meeting the < 20 open PRs requirement, it seems OK to just do the thing and not worry too much about the disruption / blasting the SIG ML) (edited) 

bentheelder:dns:  5 days ago
It's also not possible to assign a team across orgs, I think.

bentheelder:dns:  5 days ago
  Once all non-disruptive tasks have been completed and disruptive tasks have been identified, assign the GitHub Management team (@kubernetes/owners) for approval.

[nikhita]

From @cblecker (ref: slack message):

I don't know if we have helper docs anywhere, but I finally flipped a table and figured out consistent git aliases for default branches without hardcoding: https://gist.github.com/cblecker/41ad288fcaaf6fbca8d2674b8b2534c8

[BenTheElder]

Thank you @nikhita!

[nikhita]

xref #5619 - Update branch rename guide with snippets to get default remote branch vs hardcode

[BenTheElder]

also branch_protection is not the real config field, it's branch-protection apparently (which is super confusing as other fields in prow typically are snake case)

https://github.com/kubernetes/test-infra/blob/7c62dd64c875ae223eee355ce1ba9a20a66ab42d/config/prow/config.yaml#L135

[BenTheElder]

KIND is done now, remaining feedback:

• A lot of the checklist mentions prow config, but github actions are in use in some subprojects and may also need updating and don't seem to have any callouts.

• I also noticed netlify will try to retain the master branch in the configured branches for build, but that doesn't seem like a big deal / wasn't difficult to cleanup.

[spiffxp]

re: kubernetes/k8s.io#1792 (comment), that would be good ol' kubernetes/test-infra#7971 which kept aging out

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

[BenTheElder]

I think recent projects have had a smoother time. A number are still tripping over prow config but otherwise doing OK I think.

[nikhita]

/remove-lifecycle stale

[spiffxp]

/milestone v1.23
I've noticed more people going through the docs but haven't seen much feedback about whether there are points of confusion.

[spiffxp]

/priority awaiting-more-evidence
I've moved this to Blocked because I feel like we need to decide whether they're good enough, or we're just holding this open in perpetuity.

I feel like we need to consider how to more widely / easily federate people migrating their repos, and if we think the docs are good enough for that, then we're good to go. This could look like opening up a placeholder issue in all repos that have yet to migrate, with the checklist as the issue body.

[mrbobbytables]

I think the current docs are good enough.

For what its worth re:organizing people to migrate we were tossing an idea around to make it a community wide activity as part of the EoY contributor celebration. It'd be after the last release is cut and during the lull between releases. I do kinda like the idea of opening up issues in the repos ahead of time and assign to repo admins - give folks a little time to think about prepping for it with explicit links to instructions.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[mrbobbytables]

Following up on last comment, going to go ahead and close this out.

/close

[k8s-ci-robot]

@mrbobbytables: Closing this issue.

In response to this:

Following up on last comment, going to go ahead and close this out.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[BenTheElder]

/remove-lifecycle stale