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

Please rename default branch from 'master' to 'main' per Khronos policy #164

Closed
oddhack opened this issue Jan 10, 2023 · 7 comments
Closed
Assignees

Comments

@oddhack
Copy link

oddhack commented Jan 10, 2023

To repository owners: please rename the default branch of this repository from 'master' to 'main', using the Github renaming tool. This request is per policy set by the Khronos Promoters in May 2021, to follow Github community practice for respectful naming.

The Github renaming tool sets up URL redirections and retargets outstanding pull requests, so the impact on repository users is minimal. The most visible issue is that people with local repo clones will probably want to rename their clone's 'master' branch, following the popup instructions that will be seen when browsing the github repository after the change; or just delete 'master' and pull the new 'main', if it's purely a tracker with no local content.

You may wish to coordinate with @outofcontrol if you are doing auto-updates from this repository to another location, whether via push/pull mirroring or other mechanisms. The redirects setup by Github should accommodate most such uses transparently, but it's still good practice.

Based on experience with other KhronosGroup repositories which have undergone this renaming already, this is a reasonable approach:

  • Agree on a date for the renaming within the Working Group or other owners of the repository, and document that date here.
    • Date can be adjusted to avoid interaction with major releases in flight.
  • Provide notice to repository users outside Khronos, insofar as possible (adding a comment in the repo README with the switchover date is one way).
  • Once the renaming is done, edit the new 'main' branch to replace hardwired references to 'master' with (preferably) 'default branch' or 'main'.
  • Update the repo README to note the change.

If you have questions or issues about this, please raise them on Khronos internal gitlab 'khronos-general' issue 106 if possible. If not possible, you can @-tag me here.

While we will not force any WG into acting precipitously, this is our agreed policy. Please try to accommodate renaming relatively soon.

Note that this issue is automatically generated, due to the large number of KhronosGroup repositories it's being raised in.

@chaoticbob chaoticbob assigned chaoticbob and dnovillo and unassigned chaoticbob Apr 27, 2023
@dnovillo
Copy link
Contributor

I'm about to do this rename operation. @chaoticbob any particular announcement to make in some mailing list?

@chaoticbob
Copy link
Contributor

I don't think we're that popular.

@dnovillo
Copy link
Contributor

lol. fair enough. I'll need to make some changes to our internal mirrors, so I'll actually do this on Monday to avoid breaking things over the weekend.

@dnovillo
Copy link
Contributor

dnovillo commented May 2, 2023

@chaoticbob could you add me to the list of maintainers for this repo? I do not have permissions to edit the name of the master branch (following the instructions in https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch)

@outofcontrol
Copy link

@dnovillo You should be all set now.

@chaoticbob
Copy link
Contributor

@dnovillo we can close this now?

@dnovillo
Copy link
Contributor

Yup! Sorry. Forgot to close it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants