Rename default branch to main

[tam7t]

Describe the solution you'd like
Tracking but for renaming the default branch to main

Anything else you would like to add:

• Changing default branch names to main kubernetes/org#2222
• Rename default branch for kubernetes/k8s.io kubernetes/k8s.io#1597

Prerequisites

• Create an issue in your repo to track the branch rename.
  You can paste this checklist in the issue body.

• 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.

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 [prep kubernetes/org jobs for default branch rename kubernetes/test-infra#20665] for an example).

• If the [milestone_applier] prow config references the master branch,
  add the main branch to the config (see [Prep kubernetes/k8s.io for default branch rename kubernetes/test-infra#20675] for an example).

• 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.

• 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. [Allow pod-utils / clonerefs to use default remote branch 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. [Allow bootstrap to use default remote branch kubernetes/test-infra#20672] may eventually allow
    for non-disruptive changes.

• 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.

• 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

• 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

• If a prowjob still references the master branch in the branches field,
  remove the master branch (see [Update kubernetes/org job configs post default-branch-rename kubernetes/test-infra#20669] for an example).

Prow config

• If the [milestone_applier] prow config references the master branch,
  remove it from the config.

• 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).

• 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

• 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].

[aramase]

Ref: https://www.kubernetes.dev/resources/rename/

/assign

[aramase]

Updated the PR description with the checklist from the document

[aramase]

Renaming the branch from master to main will also break the helm charts.

helm repo add secrets-store-csi-driver https://raw.githubusercontent.com/kubernetes-sigs/secrets-store-csi-driver/master/charts

The long term solution was to move the helm charts to gh-pages which will alleviate this concern and not rely on the branch names going forward: #687

[aramase]

1. The helm charts have been moved to gh-pages: helm: update chart repo to https://kubernetes-sigs.github.io/secrets-store-csi-driver/charts #695
2. Non-disruptive changes in test-infra have been merged
3. There is a PR open for disruptive changes

Pending:

1. Update netlify to main post approval.
2. Merge the disruptive changes PR in test-infra
3. Rename branch from master to main
4. PR to update docs and references

[aramase]

/assign @kubernetes/owners

as suggested in https://www.kubernetes.dev/resources/rename/#approval

[spiffxp]

LGTM as a member of @kubernetes/owners

[aramase]

The branch rename is complete.

All contributors will need to follow these instructions for renaming their local branch.

[aramase]

All the changes are complete. We've sent a notice on the mailing list: https://groups.google.com/g/kubernetes-secrets-store-csi-driver/c/-a-88haTlTQ/m/ESi28uGeBgAJ and posted on slack.

/close

[k8s-ci-robot]

@aramase: Closing this issue.

In response to this:

All the changes are complete. We've sent a notice on the mailing list: https://groups.google.com/g/kubernetes-secrets-store-csi-driver/c/-a-88haTlTQ/m/ESi28uGeBgAJ and posted on slack.

/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.