Rename the master branch to main

Author: rafaelfranca

bin/generate_docs.rb

@@ -8,7 +8,7 @@
 
 LockFile.acquiring('docs_generation.lock') do
   git_manager = GitManager.new(Dir.home)
-  git_manager.update_master
+  git_manager.update_main
 
   generator = DocsGenerator.new(Dir.home, git_manager)
   generator.generate

config/crontab

@@ -32,7 +32,7 @@ BASH_ENV=~/.profile
 
 # Git complains from time to time about unreachable objects. This job makes sure
 # the repo is kept in good shape.
-@daily cd ~/master && git prune && git gc
+@daily cd ~/main && git prune && git gc
 @daily cd ~/rails-contributors/shared/rails.git && git prune && git gc
 
 @reboot cd ~/rails-contributors/current && bundle exec puma -C /home/rails/rails-contributors/shared/puma.rb --daemon

lib/docs_generator.rb

@@ -3,20 +3,20 @@
 require 'docs_compressor'
 require 'git_manager'
 require 'generators/release'
-require 'generators/master'
+require 'generators/main'
 require 'version_number'
 
 # This class is responsible for coordinating docs generation.
 #
-# The documentation is generated below `basedir`. There, each release and master
+# The documentation is generated below `basedir`. There, each release and main
 # have their own directory:
 #
 #   tag1
 #   tag2
 #   tag3
 #   ...
 #   tagN
-#   master
+#   main
 #
 # The generator checks the current release tags of the project to detect new
 # releases in any of the branches from 3.2 up.
@@ -29,7 +29,7 @@
 #   api/v4.1.0 -> basedir/v4.1.0/doc/rdoc
 #   api/v4.1   -> api/v4.1.0
 #   api/stable -> api/v4.1.0
-#   api/edge   -> basedir/master/doc/rdoc
+#   api/edge   -> basedir/main/doc/rdoc
 #
 # and same for guides:
 #
@@ -38,15 +38,15 @@
 #   guides/v4.1.0 -> basedir/v4.1.0/guides/output
 #   guides/v4.1   -> guides/v4.1.0
 #   guides/stable -> guides/v4.1.0
-#   guides/edge   -> basedir/master/guides/output
+#   guides/edge   -> basedir/main/guides/output
 #
 # If new releases are detected, symlinks are adjusted as needed.
 #
 # Once everything related to release docs is done, edge docs are generated.
 #
 # Documentation files are further compressed to leverage NGINX gzip_static.
 #
-# The docs generator assumes a master directory with an up to date working
+# The docs generator assumes a main directory with an up to date working
 # copy, it is the responsability of the caller to get that in place via the
 # git manager. It is also the responsibility of the caller to ensure there is
 # only one generator being executed at the same time.
@@ -109,14 +109,14 @@ def generate_docs_for_release(tag)
   end
 
   def generate_edge_docs
-    generator = Generators::Master.new(git_manager.short_sha1, 'master')
+    generator = Generators::Main.new(git_manager.short_sha1, 'main')
     generator.generate
 
     DocsCompressor.new(generator.api_output).compress
     DocsCompressor.new(generator.guides_output).compress
 
     # Force the recreation of the symlink to be forward compatible, if the docs
-    # structure changes in master we need the symlink to point to the new dirs.
+    # structure changes in main we need the symlink to point to the new dirs.
     create_api_symlink(generator.api_output, EDGE, force: true)
     create_guides_symlink(generator.guides_output, EDGE, force: true)
   end

lib/generators/config/master.rb

@@ -1,6 +1,6 @@
 module Generators
   module Config
-    module Master
+    module Main
       def ruby_version
         '2.5.3'
       end

lib/generators/master.rb

@@ -1,11 +1,11 @@
 require 'find'
 require 'fileutils'
 require 'generators/base'
-require 'generators/config/master'
+require 'generators/config/main'
 
 module Generators
-  class Master < Base
-    include Config::Master
+  class Main < Base
+    include Config::Main
 
     def generate_api
       start = Time.now

lib/git_manager.rb

@@ -16,15 +16,15 @@ def remote_rails_url
     'https://github.com/rails/rails.git'
   end
 
-  def update_master
+  def update_main
     Dir.chdir(basedir) do
-      unless Dir.exist?('master')
-        log "cloning master into #{basedir}/master"
-        log_and_system "git clone -q #{remote_rails_url} master"
+      unless Dir.exist?('main')
+        log "cloning main into #{basedir}/main"
+        log_and_system "git clone -q #{remote_rails_url} main"
       end
 
-      Dir.chdir('master') do
-        log 'updating master'
+      Dir.chdir('main') do
+        log 'updating main'
 
         # Bundler may modify BUNDLED WITH in Gemfile.lock and that may prevent
         # git pull from succeeding. Starting with Bundler 1.10, if Gemfile.lock
@@ -48,7 +48,7 @@ def checkout(tag)
   end
 
   def release_tags
-    Dir.chdir("#{basedir}/master") do
+    Dir.chdir("#{basedir}/main") do
       `git tag`.scan(/^v[\d.]+$/)
     end
   end
@@ -58,7 +58,7 @@ def short_sha1
   end
 
   def sha1
-    Dir.chdir("#{basedir}/master") do
+    Dir.chdir("#{basedir}/main") do
       `git rev-parse HEAD`.chomp
     end
   end

test/docs_generator_test.rb

@@ -64,15 +64,15 @@ def test_generates_docs
       mkdir 'basedir'
 
       git_manager = GitManager.new('basedir')
-      git_manager.update_master
+      git_manager.update_main
 
-      mkdir_p 'master/doc/rdoc'
+      mkdir_p 'main/doc/rdoc'
 
-      html_orphan = 'master/doc/rdoc/orphan.html'
+      html_orphan = 'main/doc/rdoc/orphan.html'
       touch html_orphan
       assert_exists html_orphan # ensure the setup is correct to prevent a false positive later
 
-      html_gz_orphan = 'master/doc/rdoc/orphan.html.gz'
+      html_gz_orphan = 'main/doc/rdoc/orphan.html.gz'
       touch html_gz_orphan
       assert_exists html_gz_orphan # ensure the setup is correct to prevent a false positive later
 
@@ -114,24 +114,24 @@ def test_generates_docs
         # --- Edge ---------------------------------------------------------------
         #
 
-        assert_exists 'master/doc/rdoc/index.html'
-        assert_exists 'master/doc/rdoc/index.html.gz'
-        assert_exists 'master/doc/rdoc/edge_badge.png'
+        assert_exists 'main/doc/rdoc/index.html'
+        assert_exists 'main/doc/rdoc/index.html.gz'
+        assert_exists 'main/doc/rdoc/edge_badge.png'
 
-        html = File.read('master/doc/rdoc/files/railties/RDOC_MAIN_rdoc.html')
-        assert html.include?("Ruby on Rails master@#{git_manager.short_sha1}")
+        html = File.read('main/doc/rdoc/files/railties/RDOC_MAIN_rdoc.html')
+        assert html.include?("Ruby on Rails main@#{git_manager.short_sha1}")
         assert html.include?('<img src="/edge_badge.png"')
 
-        assert !File.read('master/doc/rdoc/panel/index.html').include?('edge_badge.png')
+        assert !File.read('main/doc/rdoc/panel/index.html').include?('edge_badge.png')
 
-        assert_exists 'master/guides/output/index.html'
-        assert_exists 'master/guides/output/index.html.gz'
-        refute_exists "master/guides/output/kindle/ruby_on_rails_guides_#{git_manager.short_sha1}.mobi"
+        assert_exists 'main/guides/output/index.html'
+        assert_exists 'main/guides/output/index.html.gz'
+        refute_exists "main/guides/output/kindle/ruby_on_rails_guides_#{git_manager.short_sha1}.mobi"
 
-        assert_equal File.expand_path('master/doc/rdoc'), File.readlink('api/edge')
-        assert_equal File.expand_path('master/guides/output'), File.readlink('guides/edge')
+        assert_equal File.expand_path('main/doc/rdoc'), File.readlink('api/edge')
+        assert_equal File.expand_path('main/guides/output'), File.readlink('guides/edge')
 
-        html = File.read('master/guides/output/index.html')
+        html = File.read('main/guides/output/index.html')
         assert html.include?("Ruby on Rails Guides (#{git_manager.short_sha1})")
         assert html.include?('<img src="images/edge_badge.png"')
 

test/git_manager_test.rb

@@ -12,9 +12,9 @@ def create_repository
 
   def test_checkout
     in_tmpdir do
-      mkdir_p 'basedir/master'
+      mkdir_p 'basedir/main'
 
-      chdir 'basedir/master' do
+      chdir 'basedir/main' do
         create_repository
 
         system 'echo t1 > README'
@@ -27,7 +27,7 @@ def test_checkout
       end
 
       gm = GitManager.new('basedir')
-      gm.stub('remote_rails_url', "file://#{Dir.pwd}/basedir/master") do
+      gm.stub('remote_rails_url', "file://#{Dir.pwd}/basedir/main") do
         gm.checkout('t1')
       end
 
@@ -38,9 +38,9 @@ def test_checkout
 
   def test_release_tags
     in_tmpdir do
-      mkdir_p 'basedir/master'
+      mkdir_p 'basedir/main'
 
-      chdir 'basedir/master' do
+      chdir 'basedir/main' do
         create_repository
         %w(0.9.4.1 2.3.9.pre 3.0.0_RC2 3.2.8.rc1 3.2.14 v4.0.0.beta1 4.0.1).each do |version|
           system "git tag v#{version}"
@@ -54,10 +54,10 @@ def test_release_tags
 
   def test_sha1_and_short_sha1
     in_tmpdir do
-      mkdir_p 'basedir/master'
+      mkdir_p 'basedir/main'
 
       sha1 = nil
-      chdir 'basedir/master' do
+      chdir 'basedir/main' do
         create_repository
         sha1 = `git rev-parse HEAD`.chomp
       end