Merge pull request #5898 from rubygems/better-releases

Small improvements to the release process

Author: deivid-rodriguez

POLICIES.md

@@ -42,8 +42,19 @@ at version 2.7, so when RubyGems 2.8 is released, it will only support Ruby
 
 ## Release Process
 
-Releases of new versions should follow these steps, to ensure the process is
-smooth and no needed steps are missed.
+### Permissions
+
+You'll need the following environment variables set to release RubyGems &
+Bundler:
+
+* AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY: to be able to push RubyGems zip
+  files to s3 so that they appear at RubyGems [download page].
+
+* GITHUB_RELEASE_PAT: A [GitHub PAT] with repo permissions, in order to push
+  GitHub releases and to use the GitHub API for changelog generation.
+
+[download page]: https://rubygems.org/pages/download
+[GitHub PAT]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
 
 ### Recommendations for security releases
 
@@ -54,14 +65,16 @@ smooth and no needed steps are missed.
     have to work on weekends.
 *   Continue with the regular release process below.
 
-
 ### Steps for patch releases
 
 *   Confirm all PRs that you want backported are properly tagged with `rubygems:
     <type>` or `bundler: <type>` labels at GitHub.
-*   Run `rake prepare_release[<target_version>]`, create a PR and merge it
-    to the stable branch once CI passes.
-*   Switch to the stable branch and pull the PR just merged.
+*   Run `rake prepare_release[<target_version>]`. This will create a PR to the
+    stable branch with the backports included in the release, and proper
+    changelogs and version bumps. It will also create a PR to merge release
+    changelogs into master.
+*   Once CI passes, merge the release PR, switch to the stable branch and pull
+    the PR just merged.
 *   Release `bundler` with `(cd bundler && bin/rake release)`.
 *   Release `rubygems` with `rake release`.
 

bundler/tool/bundler/release_gems.rb

@@ -2,6 +2,5 @@
 
 source "https://rubygems.org"
 
-gem "netrc", "~> 0.11.0"
 gem "octokit", "~> 4.18"
 gem "aws-sdk-s3", "~> 1.87"

bundler/tool/bundler/release_gems.rb.lock

@@ -44,7 +44,6 @@ GEM
     faraday-retry (1.0.3)
     jmespath (1.5.0)
     multipart-post (2.1.1)
-    netrc (0.11.0)
     octokit (4.22.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
@@ -65,7 +64,6 @@ PLATFORMS
 
 DEPENDENCIES
   aws-sdk-s3 (~> 1.87)
-  netrc (~> 0.11.0)
   octokit (~> 4.18)
 
 BUNDLED WITH

util/release.rb

@@ -6,11 +6,8 @@ class Release
   module GithubAPI
     def gh_client
       @gh_client ||= begin
-        require "netrc"
-        _username, token = Netrc.read["api.github.com"]
-
         require "octokit"
-        Octokit::Client.new(:access_token => token)
+        Octokit::Client.new(:access_token => ENV["GITHUB_RELEASE_PAT"])
       end
     end
   end
@@ -187,13 +184,32 @@ def prepare!
 
       return if @level == :minor_or_major
 
+      system("git", "push", exception: true)
+
+      gh_client.create_pull_request(
+        "rubygems/rubygems",
+        @base_branch,
+        @release_branch,
+        "Prepare RubyGems #{@rubygems.version} and Bundler #{@bundler.version}",
+        "It's release day!"
+      )
+
       system("git", "checkout", "-b", "cherry_pick_changelogs", "master", exception: true)
 
       begin
         system("git", "cherry-pick", bundler_changelog, rubygems_changelog, exception: true)
+        system("git", "push", exception: true)
       rescue StandardError
         system("git", "cherry-pick", "--abort")
         system("git", "branch", "-D", "cherry_pick_changelogs")
+      else
+        gh_client.create_pull_request(
+          "rubygems/rubygems",
+          "master",
+          "cherry_pick_changelogs",
+          "Changelogs for RubyGems #{@rubygems.version} and Bundler #{@bundler.version}",
+          "Cherry-picking change logs from future RubyGems #{@rubygems.version} and Bundler #{@bundler.version} into master."
+        )
       end
     rescue StandardError
       system("git", "checkout", initial_branch)