Rename repo and default branch

[justaugustus]

What would you like to be added:

As we start to integrate promotion tools back into the image promoter repo, I'd like to take the opportunity to:

• Rename the repo
• Change the default branch name to main

As both of those touch roughly the same files, I'd like to handle them together.

I have two ideas for repo names, so let's vote!

1. sigs.k8s.io/kpromo (the name of the artifact promotion CLI tool)
2. sigs.k8s.io/promo-tools

For other name suggestions, comment here or on this thread: https://kubernetes.slack.com/archives/CJH2GBF7Y/p1631538346069100

Why is this needed

1. The repo name is unnecessarily long and no longer effectively represents all of the content contained therein
2. Community-wide effort around Inclusive Naming: Changing default branch names to main kubernetes/org#2222

---

Default Branch Migration

(Copied from https://k8s.dev/rename)

This document outlines steps needed to migrate the default branch
of your repo from master to main.

Note: This document is currently a work in progress.

If you have questions about the process, reach out to the GitHub Management Team
on the #github-management channel on slack or open an issue in the kubernetes/org repo.

Prerequisites

• Create an issue in your repo to track the branch rename: Rename repo and default branch #424
• If you are not a root approver for the repo, assign a root
  approver for approval
• Once the issue has been approved, send a notice to your SIG's
  mailing list about the potential branch rename: https://groups.google.com/g/kubernetes-dev/c/YnIYtEBURvk

Changes pre-rename

Make the following changes before renaming the branch the master branch.

Note: There might be additional changes required that have not been
covered in this checklist.

Anytime

These changes are non-disruptive and can be made anytime before renaming
the branch.

• If a presubmit or postsubmit prowjob triggers on the master branch
  (branches field of the prowjob), add the main branch to the list
  (see kubernetes/test-infra#20665 for an example): SIG Release cleanups kubernetes/test-infra#23332

• (N/A) If the milestone_applier prow config references the master branch,
  add the main branch to the config (see kubernetes/test-infra#20675 for an example).

• (N/A) If the branch_protection prow config references the master branch,
  add the main branch to the config.

Just before rename

These changes are disruptive and should be made just before renaming the
branch.

• (N/A) For periodic prowjobs, or any prowjob that mentions the master branch
  in base_ref, update them to the main branch. Ensure that these changes
  happen in lock-step with the branch rename (jobs triggered in between landing
  these changes and renaming the branch will fail).

  • For bootstrap-based jobs, ensure the branch is explicitly specified,
    e.g. kubernetes/foo=main. kubernetes/test-infra#20667 may eventually
    allow for non-disruptive changes.
  • For pod-utils based jobs, ensure the branch is explicitly specified,
    e.g. base_ref: main. kubernetes/test-infra#20672 may eventually allow
    for non-disruptive changes.

• (N/A) If a prowjob mentions master in its name, rename the job to not include
  the branch name, e.g. pull-repo-verify-master -> pull-repo-verify.
  status-reconciler should automatically migrate PR status contexts to the
  new job name, and retrigger accordingly, but we have anecdotally found it
  sometimes misses changes.

  • NOTE: our infrastructure doesn't understand the concept of job renames, so
    from the perspective of e.g. https://testgrid.k8s.io the job will appear to
    have lost history and start from scratch.

• (N/A) If a prowjob calls scripts or code in your repo that explicitly
  reference master, update all references to use main, or auto-detect the
  remote branch

  • e.g. using git to auto-detect

  # for existing clones, update their view of the remote
  git fetch origin
  git remote set-head origin -a
  # for new clones, or those updated as above, this prints "main" post-rename
  echo $(git symbolic-ref refs/remotes/origin/HEAD)

  • e.g. using github's api to auto-detect

  # gh is https://github.com/cli/cli, this will print "main" post-rename
  gh api /repos/kubernetes-sigs/slack-infra | jq -r .default_branch

• (N/A) If the repo has netlify configured for it, ask a member of the GitHub
  Management Team to rename the master branch to main in the netlify site config.
  It can't be controlled through the netlify config in the repo.

Approval

• Once all non-disruptive tasks have been completed and disruptive tasks
  have been identified, assign the GitHub Management team (@kubernetes/owners)
  for approval.

Rename the default branch

• Rename the default branch from master to main using the GitHub UI
  by following the official instructions.

Changes post-rename

After the default branch has been renamed to main, make the following
changes.

Note: There might be additional changes required that have not been
covered in this checklist.

Prowjobs

• (N/A) If a prowjob still references the master branch in the branches field,
  remove the master branch (see kubernetes/test-infra#20669 for an example): releng: Post-rename tasks for sigs.k8s.io/promo-tools kubernetes/test-infra#23626

Prow config

• (N/A) If the milestone_applier prow config references the master branch,
  remove it from the config.

• (N/A) If the branch_protection prow config references the master branch,
  remove it from the config.

Other

• If any docs reference the master branch, update to main
  (URLs will be automatically redirected)

  • sig-release: Update Release Engineering OWNERS references kubernetes/community#6023

• Ensure that CI and PR tests work fine.

  • If there are any outstanding PRs you can /approve to merge, do so to verify
    that presubmits and postsubmits work as expected:
    • Update references to default development branch #429

• Trial the local development experience with a pre-rename clone.

  • ensure Github instructions to rename your local branch work
  • consider updating your fork's default remote branch name such that if you
    have git autocompletion enabled, typing ma<tab> will autocomplete to main

• Send a notice about the branch rename to your SIG's mailing list.
  Include the link to the GitHub instructions to rename your local branch: https://groups.google.com/g/kubernetes-dev/c/YnIYtEBURvk/m/lF7DCIGmBwAJ

• cs.k8s.io references

  • Update Golang consumers:
    • k/release: go.mod: Update sigs.k8s.io/promo-tools/v3 to v3.2.1 kubernetes/release#2255
  • k/community: sig-release: Update Release Engineering OWNERS references kubernetes/community#6023
  • k/enhancements: sig-release(1732): Update references to sigs.k8s.io/promo-tools kubernetes/enhancements#2979
  • k/ingress-nginx: Changelog.md: Update references to sigs.k8s.io/promo-tools kubernetes/ingress-nginx#7656
  • k/k8s.io: releng: Update references to sigs.k8s.io/promo-tools kubernetes/k8s.io#2752
  • k/kops: release-process.md: Update references to artifact promotion kubernetes/kops#12386
  • k/org: Update SIG Release teams kubernetes/org#2984

/assign
cc: @kubernetes-sigs/release-engineering

[justaugustus]

Votes so far:

• sigs.k8s.io/promo-tools: 6 - @ameukam @jeremyrickard @puerco @randomvariable @cpanato @jimangel
• sigs.k8s.io/kpromo: 1 - @pacoxu

[justaugustus]

Notice to k-dev: https://groups.google.com/g/kubernetes-dev/c/YnIYtEBURvk

[justaugustus]

Opened a PR for the repo rename: kubernetes/test-infra#23605

[justaugustus]

Will be completed via kubernetes/k8s.io#2752.
/close

[k8s-ci-robot]

@justaugustus: Closing this issue.

In response to this:

Will be completed via kubernetes/k8s.io#2752.
/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.