Proposal: Rename default branch to main

[colby-swandale]

Abstract

I wish to propose renaming the default branch from master to main. The larger developer community has been moving away from non-inclusive terms such as master, slave, blacklist, whitelist, and I wish for RubyGems & RubyGems.org to do the same.

Other examples of open source projects renaming their default branch main:

• Change the default branch name for new Rails projects from master to main rails/rails#40214
• Change default branch for new Rails projects and plugins to main rails/rails#40254
• https://make.wordpress.org/core/2020/06/18/proposal-update-all-git-repositories-to-use-main-instead-of-master/

This change is relatively minimal thanks to Github natively supporting renaming the default branch to main and will do most of the work for us automatically, such as adding automatic redirects & updating existing Pull Requests to point to main. But this will require some manual steps.

You can find more information at: https://github.com/github/renaming.

Steps Required

As mentioned, Github automates most of the needed steps to switch the default branch to main, but some steps still need to be performed manually by maintainers before & after the rename.

The following list covers steps that to my knowledge are required to do, but may not be indicative of covering everything.

Github Actions

Before renaming the default branch in Github, the Github Action Workflows will need to be amended to mirror the main and master branches. So that we can test pushing a commit to main, while developers continue to use master.

Update branch protection rules

We currently use branch protection to prevent merging Pull Requests that do not pass the status checks. This rule will need to be updated to use main after the default branch changes.

Local Migration

After the rename, developers will need to migrate their local development environment to main. This migration can be done by renaming the master branch to main and updating the remote to origin/main

$ git checkout master
$ git branch -m main
$ git branch -u origin/main

Remove/Rename references to master branch

Update Github actions to remove any branch filtering on the master branch and rename any references to master in the documentation & source code.

Renaming the default branch

The default branch can be renamed in Github, which is documented in doc.github.com

Questions

• What impacts would this change cause downstream, such as Ruby-src, Truffleruby & JRuby?

  • How best do we communicate this change to maintainers?

• Are any scripts/tooling affected by this proposed change?

• Is the workflow in bundler-site affected by this proposed change?

[simi]

IMHO we should just copy Ruby repo standards and discuss overall renaming of all Ruby repos (including std. libs - RubyGems) at https://bugs.ruby-lang.org/.

[hsbt]

Ruby core followed Matz's opinion. I also agreed him.

[deivid-rodriguez]

I'm in favor of doing this.

[deivid-rodriguez]

What impacts would this change cause downstream, such as Ruby-src, Truffleruby & JRuby?

It does affect syncing with ruby-core because current scripts hardcode "master" as the default branch. They would need to be updated to infer the default branch for each repository instead of hardcoding it.

Are any scripts/tooling affected by this proposed change?

The scripts that generate the changelog will be affected, and also GitHub workflows.

Is the workflow in bundler-site affected by this proposed change?

Most likely yes.

[deivid-rodriguez]

We currently use branch protection to prevent merging Pull Requests that do not pass the status checks. This rule will need to be updated to use main after the default branch changes.

I skimmed through https://github.com/github/renaming and apparently GitHub does this now automatically too 🎉.

[deivid-rodriguez]

I moved this to a discussion, it fits better here in my opinion.

[indirect]

I'm also in favor of changing the repo's default branch to main. Following best practices is something that has been important to the entire Bundler team for many years. In the beginning, those best practices included having an extensive test suite, limiting breaking changes, and having an extensive documentation website. Over the last 5 or so years, those best practices have grown to include using an automatic linter, having a code of conduct, and using the default git branch main.

Personally, I want Bundler to continue to be an example of current best practices, as much as possible, so I am strongly in favor of making this change.

[simi]

I think the major problems are actually technical ones. With limited time we have to work on the projects this is not most critical problem and thus not on top of the priority list. Anyone is welcomed to take a look to summary the impact (mainly synchronize with Ruby side) and help with transition.

[deivid-rodriguez]

Indeed the ruby-core synchronization script hardcodes "master" assuming all default repositories have their default branch named master. So the tool/sync_default_gems.rb script in ruby/ruby needs to be made generic first.