Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tracking: switch default branch to main #2120

Closed
20 tasks done
BenTheElder opened this issue Mar 11, 2021 · 10 comments
Closed
20 tasks done

tracking: switch default branch to main #2120

BenTheElder opened this issue Mar 11, 2021 · 10 comments
Assignees
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. sig/testing Categorizes an issue or PR as relevant to SIG Testing. wg/naming Categorizes an issue or PR as relevant to WG Naming.
Milestone

Comments

@BenTheElder
Copy link
Member

BenTheElder commented Mar 11, 2021

see: https://k8s.dev/rename, kubernetes/org#2222

Checklist below added from kubernetes/community@198374d

Prerequisites

  • Ensure that your repo has low PR volume (<20 open PRs) and
    less number of periodic jobs. The branch rename will re-trigger
    prow on all open PRs, which will cause a huge spike in the CI load.

    • We have zero periodic jobs directly consuming this repo
    • We have < 10 PRs open now (17:14 PST 2021-03-15)
  • Create an issue in your repo to track the branch rename.
    You can paste this checklist in the issue body.

    • This is the issue
  • If you are not a root approver for the repo, assign a root
    approver for approval.

    • I am a root approver
  • 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.

Just before rename

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

  • If a prowjob mentions the master branch in base_ref,
    update it to the main branch. For a periodic job, ensure that
    the branch is renamed between periodic job runs.

    • N/A we have no jobs that mention branches of this repo.
  • If a prowjob mentions master in its name, rename the job to
    to not include the branch name. [status-reconciler] should automatically
    migrate the PR status contexts to the new job name but this has not been tested yet.
    The job with the new name will also appear as a different job in Testgrid.

    • N/A we have no jobs that mention branches of this repo.
  • If a prowjob calls scripts or code in your repo that explicitly
    reference master, update all references to use main.

    • N/A we don't do this.
  • 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.

    • We will need to do this.
    • This is done.

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

Prow config

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

    • N/A we don't use milestone_applier here
  • If the [branch_protection] prow config references the master branch,
    remove it from the config.

    • N/A we don't have any repo specific branch_protection config (just the automated standard configuration)

Other

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

    • This is done.
  • Ensure that CI and PR tests work fine.

    • Look fine so far.
  • Trial the local development experience with a pre-rename clone.

    • Nothing in our development experience is branch specific, I just needed to switch from master to main as expected.
  • 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].

/assign

@BenTheElder BenTheElder added kind/feature Categorizes issue or PR as related to a new feature. wg/naming Categorizes an issue or PR as relevant to WG Naming. labels Mar 11, 2021
@BenTheElder BenTheElder added the sig/testing Categorizes an issue or PR as relevant to SIG Testing. label Mar 11, 2021
@BenTheElder
Copy link
Member Author

went through the current checklist, discussing some feedback in slack here: https://kubernetes.slack.com/archives/C1TU9EB9S/p1615487742145000

@BenTheElder
Copy link
Member Author

will follow up further next week (I am unavailable friday, and it seems best to not try to switch this on a friday anyhow)

@BenTheElder
Copy link
Member Author

Went through the checklist.

We need to send the mailinglist notice, and we'll need help from GitHub management to update Netlify. The rest should be fine.

Will aim to do this Tomorrow.

@BenTheElder BenTheElder added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 16, 2021
@BenTheElder
Copy link
Member Author

BenTheElder commented Mar 16, 2021

@mrbobbytables
Copy link
Member

/approve 👍

@spiffxp
Copy link
Member

spiffxp commented Mar 16, 2021

/assign @kubernetes/owners

@spiffxp
Copy link
Member

spiffxp commented Mar 16, 2021

Ah right. Different org

@BenTheElder
Copy link
Member Author

/assign @kubernetes/owners

This is one of the things I have in kubernetes/community#5636, that's not possible.

@BenTheElder
Copy link
Member Author

Cleaned up references in #2137. After merge we can see https://kind.sigs.k8s.io/ is at b30f419 so the netlify settings worked as well.

@BenTheElder
Copy link
Member Author

Left some more feedback kubernetes/community#5636 (comment)

And updated the mailinglist. This is done. Thanks all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. sig/testing Categorizes an issue or PR as relevant to SIG Testing. wg/naming Categorizes an issue or PR as relevant to WG Naming.
Projects
None yet
Development

No branches or pull requests

3 participants