...
To rename the default branch, we recommend using the github-default-branch.
This tool will:
In the remote repository on GitHub, this tool will automatically:
- Rename the default branch from master to main
- Remove references to master in the branch interface
- Copy branch protection rules on master to main
- Update open pull requests pointing to master, to point to main
- Update references in issues from master to mainOffer
It also offers the ability for most local copies to update against the remote with a series of short commands
...
, which would need to be done locally for each local copy that contains an outdated reference to master.
This tool will not:
- Reliably propagate changes to the default branch across forks of the repository
- Correct references to master in the repository’s wiki
- Update references to the main branch for automation and deployment workflows with tools such as Jenkins, Ansible
- Update external integrations with tools such as circleci, coveralls, Slack integrations, etc.
- Update hard-coded references to the outdated branch in code (eg Gemfile pins)
...
To track progress, we have a spreadsheet for branch renaming in the “samvera” and “samvera-labs” GitHub organizations, and welcome the CCWG to use this to track progress as well.
Next steps
- Prioritize repositories for renaming.
- Determine a method for tracking and sharing out progress.
- Agree upon a communication strategy to stay in touch with the BRWG while that group is on hiatus.
- When the BRWG reconvenes in January 2021, check in on the process of renaming, and what options are available based on newly-available tools in GitHub. The BRWG will schedule and facilitate this.
- In 2021, schedule a date when the "master" branch will no longer be available in the “samvera” and “samvera-labs” GitHub organizations, factoring in availability of resources within the community for this.