Extract logic to release Rails into a separate tool

Author: rafaelfranca

.github/workflows/rails_releaser_tests.yml

@@ -0,0 +1,29 @@
+name: Rails releaser tests
+
+on:
+  pull_request:
+    paths:
+    - "tools/releaser/**"
+  push:
+    paths:
+    - "tools/releaser/**"
+
+permissions:
+  contents: read
+
+jobs:
+  releaser_tests:
+    name: releaser tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+      - name: Bundle install
+        run: bundle install
+        working-directory: tools/releaser
+      - run: bundle exec rake
+        working-directory: tools/releaser

Gemfile

@@ -8,6 +8,8 @@ gem "minitest"
 # We need a newish Rake since Active Job sets its test tasks' descriptions.
 gem "rake", ">= 13"
 
+gem "releaser", path: "tools/releaser"
+
 gem "sprockets-rails", ">= 2.0.0", require: false
 gem "propshaft", ">= 0.1.7"
 gem "capybara", ">= 3.39"

Gemfile.lock

@@ -121,6 +121,13 @@ PATH
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
 
+PATH
+  remote: tools/releaser
+  specs:
+    releaser (1.0.0)
+      minitest
+      rake (~> 13.0)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -688,6 +695,7 @@ DEPENDENCIES
   redcarpet (~> 3.2.3)
   redis (>= 4.0.1)
   redis-namespace
+  releaser!
   resque
   resque-scheduler
   rexml

Rakefile

@@ -7,23 +7,14 @@ require "tasks/release"
 require "railties/lib/rails/api/task"
 require "tools/preview_docs"
 
-desc "Build gem files for all projects"
-task build: "all:build"
-
-desc "Prepare the release"
-task prep_release: "all:prep_release"
-
-desc "Release all gems to rubygems and create a tag"
-task release: "all:release"
-
 desc "Run all tests by default"
 task default: %w(test test:isolated)
 
 %w(test test:isolated).each do |task_name|
   desc "Run #{task_name} task for all projects"
   task task_name do
     errors = []
-    FRAMEWORKS.each do |project|
+    Releaser::FRAMEWORKS.each do |project|
       system(%(cd #{project} && #{$0} #{task_name} --trace)) || errors << project
     end
     fail("Errors in #{errors.join(', ')}") unless errors.empty?
@@ -32,10 +23,10 @@ end
 
 desc "Smoke-test all projects"
 task :smoke, [:frameworks, :isolated] do |task, args|
-  frameworks = args[:frameworks] ? args[:frameworks].split(" ") : FRAMEWORKS
+  frameworks = args[:frameworks] ? args[:frameworks].split(" ") : Releaser::FRAMEWORKS
   # The arguments are positional, and users may want to specify only the isolated flag.. so we allow 'all' as a default for the first argument:
   if frameworks.include?("all")
-    frameworks = FRAMEWORKS
+    frameworks = Releaser::FRAMEWORKS
   end
 
   isolated = args[:isolated].nil? ? true : args[:isolated] == "true"
@@ -51,9 +42,6 @@ task :smoke, [:frameworks, :isolated] do |task, args|
   end
 end
 
-desc "Install gems for all projects."
-task install: "all:install"
-
 desc "Generate documentation for the Rails framework"
 if ENV["EDGE"]
   Rails::API::EdgeTask.new("rdoc")
@@ -75,9 +63,6 @@ task :preview_docs do
   system("tar -czf preview.tar.gz -C preview .")
 end
 
-desc "Bump all versions to match RAILS_VERSION"
-task update_versions: "all:update_versions"
-
 # We have a webhook configured in GitHub that gets invoked after pushes.
 # This hook triggers the following tasks:
 #

tasks/release.rb

@@ -1,222 +1,10 @@
 # frozen_string_literal: true
 
-# Order dependent. E.g. Action Mailbox depends on Active Record so it should be after.
-FRAMEWORKS = %w(
-  activesupport
-  activemodel
-  activerecord
-  actionview
-  actionpack
-  activejob
-  actionmailer
-  actioncable
-  activestorage
-  actionmailbox
-  actiontext
-  railties
-)
-FRAMEWORK_NAMES = Hash.new { |h, k| k.split(/(?<=active|action)/).map(&:capitalize).join(" ") }
+require "releaser"
 
 root    = File.expand_path("..", __dir__)
 version = File.read("#{root}/RAILS_VERSION").strip
-tag     = "v#{version}"
-
-directory "pkg"
-
-major, minor, tiny, pre = version.split(".", 4)
-
-# This "npm-ifies" the current version number
-# With npm, versions such as "5.0.0.rc1" or "5.0.0.beta1.1" are not compliant with its
-# versioning system, so they must be transformed to "5.0.0-rc1" and "5.0.0-beta1-1" respectively.
-# "5.0.0"     --> "5.0.0"
-# "5.0.1"     --> "5.0.100"
-# "5.0.0.1"   --> "5.0.1"
-# "5.0.1.1"   --> "5.0.101"
-# "5.0.0.rc1" --> "5.0.0-rc1"
-if pre
-  pre_release = pre.match?(/rc|beta|alpha/) ? pre : nil
-  npm_pre = pre.to_i
-else
-  npm_pre = 0
-  pre_release = nil
-end
-
-npm_version = "#{major}.#{minor}.#{(tiny.to_i * 100) + npm_pre}#{pre_release ? "-#{pre_release}" : ""}"
-pre = pre ? pre.inspect : "nil"
-
-(FRAMEWORKS + ["rails"]).each do |framework|
-  namespace framework do
-    gem     = "pkg/#{framework}-#{version}.gem"
-    gemspec = "#{framework}.gemspec"
-
-    task :clean do
-      rm_f gem
-    end
-
-    task :update_versions do
-      glob = root.dup
-      if framework == "rails"
-        glob << "/version.rb"
-      else
-        glob << "/#{framework}/lib/*"
-        glob << "/gem_version.rb"
-      end
-
-      file = Dir[glob].first
-      ruby = File.read(file)
-
-      ruby.gsub!(/^(\s*)MAJOR(\s*)= .*?$/, "\\1MAJOR = #{major}")
-      raise "Could not insert MAJOR in #{file}" unless $1
-
-      ruby.gsub!(/^(\s*)MINOR(\s*)= .*?$/, "\\1MINOR = #{minor}")
-      raise "Could not insert MINOR in #{file}" unless $1
-
-      ruby.gsub!(/^(\s*)TINY(\s*)= .*?$/, "\\1TINY  = #{tiny}")
-      raise "Could not insert TINY in #{file}" unless $1
-
-      ruby.gsub!(/^(\s*)PRE(\s*)= .*?$/, "\\1PRE   = #{pre}")
-      raise "Could not insert PRE in #{file}" unless $1
-
-      File.open(file, "w") { |f| f.write ruby }
-
-      require "json"
-      if File.exist?("#{framework}/package.json") && JSON.parse(File.read("#{framework}/package.json"))["version"] != npm_version
-        Dir.chdir("#{framework}") do
-          if sh "which npm"
-            sh "npm version #{npm_version} --no-git-tag-version"
-          else
-            raise "You must have npm installed to release Rails."
-          end
-        end
-      end
-    end
-
-    task gem => %w(update_versions pkg) do
-      cmd = ""
-      cmd += "cd #{framework} && " unless framework == "rails"
-      cmd += "gem build #{gemspec} && mv #{framework}-#{version}.gem #{root}/pkg/"
-      sh cmd
-    end
-
-    task build: [:clean, gem]
-    task install: :build do
-      sh "gem install --pre #{gem}"
-    end
-
-    task push: :build do
-      otp = ""
-      begin
-        otp = " --otp " + `ykman oath accounts code -s rubygems.org`.chomp
-      rescue
-        # User doesn't have ykman
-      end
-
-      sh "gem push #{gem}#{otp}"
-
-      if File.exist?("#{framework}/package.json")
-        Dir.chdir("#{framework}") do
-          npm_otp = ""
-          begin
-            npm_otp = " --otp " + `ykman oath accounts code -s npmjs.com`.chomp
-          rescue
-            # User doesn't have ykman
-          end
-
-          npm_tag = ""
-          if /[a-z]/.match?(version)
-            npm_tag = " --tag pre"
-          else
-            npm_tag = " --tag latest"
-          end
-
-          sh "npm publish#{npm_tag}#{npm_otp}"
-        end
-      end
-    end
-  end
-end
-
-namespace :changelog do
-  task :header do
-    (FRAMEWORKS + ["guides"]).each do |fw|
-      require "date"
-      fname = File.join fw, "CHANGELOG.md"
-      current_contents = File.read(fname)
-
-      header = "## Rails #{version} (#{Date.today.strftime('%B %d, %Y')}) ##\n\n"
-      header += "*   No changes.\n\n\n" if current_contents.start_with?("##")
-      contents = header + current_contents
-      File.write(fname, contents)
-    end
-  end
-
-  task :release_summary, [:base_release, :release] do |_, args|
-    release_regexp = args[:base_release] ? Regexp.escape(args[:base_release]) : /\d+\.\d+\.\d+/
-
-    puts args[:release]
-
-    FRAMEWORKS.each do |fw|
-      puts "## #{FRAMEWORK_NAMES[fw]}"
-      fname    = File.join fw, "CHANGELOG.md"
-      contents = File.readlines fname
-      contents.shift
-      changes = []
-      until contents.first =~ /^## Rails #{release_regexp}.*$/ ||
-          contents.first =~ /^Please check.*for previous changes\.$/ ||
-          contents.empty?
-        changes << contents.shift
-      end
-
-      puts changes.join
-      puts
-    end
-  end
-end
-
-namespace :all do
-  task build: FRAMEWORKS.map { |f| "#{f}:build"           } + ["rails:build"]
-  task update_versions: FRAMEWORKS.map { |f| "#{f}:update_versions" } + ["rails:update_versions"]
-  task install: FRAMEWORKS.map { |f| "#{f}:install"         } + ["rails:install"]
-  task push: FRAMEWORKS.map { |f| "#{f}:push"            } + ["rails:push"]
-
-  task :ensure_clean_state do
-    unless `git status -s | grep -v 'RAILS_VERSION\\|CHANGELOG\\|Gemfile.lock\\|package.json\\|version.rb\\|tasks/release.rb'`.strip.empty?
-      abort "[ABORTING] `git status` reports a dirty tree. Make sure all changes are committed"
-    end
-
-    unless ENV["SKIP_TAG"] || `git tag | grep '^#{tag}$'`.strip.empty?
-      abort "[ABORTING] `git tag` shows that #{tag} already exists. Has this version already\n"\
-            "           been released? Git tagging can be skipped by setting SKIP_TAG=1"
-    end
-  end
-
-  task :bundle do
-    sh "bundle check"
-  end
-
-  task :commit do
-    unless `git status -s`.strip.empty?
-      File.open("pkg/commit_message.txt", "w") do |f|
-        f.puts "# Preparing for #{version} release\n"
-        f.puts
-        f.puts "# UNCOMMENT THE LINE ABOVE TO APPROVE THIS COMMIT"
-      end
-
-      sh "git add . && git commit --verbose --template=pkg/commit_message.txt"
-      rm_f "pkg/commit_message.txt"
-    end
-  end
-
-  task :tag do
-    sh "git push"
-    sh "git tag -s -m '#{tag} release' #{tag}"
-    sh "git push --tags"
-  end
-
-  task prep_release: %w(ensure_clean_state changelog:header build bundle)
-
-  task release: %w(prep_release commit tag push)
-end
+releaser = Releaser.new(root, version)
 
 module Announcement
   class Version
@@ -244,7 +32,7 @@ def rc?
 
 task :announce do
   Dir.chdir("pkg/") do
-    versions = ENV["VERSIONS"] ? ENV["VERSIONS"].split(",") : [ version ]
+    versions = ENV["VERSIONS"] ? ENV["VERSIONS"].split(",") : [ releaser.version ]
     versions = versions.sort.map { |v| Announcement::Version.new(v) }
 
     raise "Only valid for patch releases" if versions.any?(&:major_or_security?)

tasks/release_announcement_draft.erb

@@ -16,8 +16,8 @@ To see a summary of changes, please read the release on GitHub:
 <%= "[#{version} CHANGELOG](https://github.com/rails/rails/releases/tag/v#{version})" %>
 
 To view the changes for each gem, please read the changelogs on GitHub:
-<% FRAMEWORKS.sort.each do |framework| %>
-<%= "* [#{FRAMEWORK_NAMES[framework]} CHANGELOG](https://github.com/rails/rails/blob/v#{version}/#{framework}/CHANGELOG.md)" %>
+<% Releaser::FRAMEWORKS.sort.each do |framework| %>
+<%= "* [#{releaser.framework_name(framework)} CHANGELOG](https://github.com/rails/rails/blob/v#{version}/#{framework}/CHANGELOG.md)" %>
 
 <% end %>
 

tools/releaser/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

tools/releaser/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    releaser (1.0.0)
+      minitest
+      rake (~> 13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.25.1)
+    rake (13.2.1)
+
+PLATFORMS
+  aarch64-linux
+  ruby
+
+DEPENDENCIES
+  releaser!
+
+BUNDLED WITH
+   2.5.17

tools/releaser/README.md

@@ -0,0 +1,3 @@
+# Releaser
+
+Collection of helpers to release Rails.