build: automate continuous delivery workflow

Use googleapis/release-please-action and rubygems/release-gem actions to automate releasing and publishing new gem versions to rubygems.
ruby-git · jcouball · May 15, 2025 · May 15, 2025 · May 15, 2025 · 3a0464212fc7c03e3fd060e856efc3beffda9690
commit 3a0464212fc7c03e3fd060e856efc3beffda9690
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,52 @@
+---
+name: Release Gem
+
+description: |
+  This workflow creates a new release on GitHub and publishes the gem to
+  RubyGems.org.
+
+  The workflow uses the `googleapis/release-please-action` to handle the
+  release creation process and the `rubygems/release-gem` action to publish
+  the gem to rubygems.org
+
+on:
+  push:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: RubyGems
+      url: https://rubygems.org/gems/git
+
+    permissions:
+      contents: write
+      pull-requests: write
+      id-token: write
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v4
+
+      - name: Create release
+        uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          token: ${{ secrets.AUTO_RELEASE_TOKEN }}
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - name: Push to RubyGems.org
+        uses: rubygems/release-gem@v1
+        if: ${{ steps.release.outputs.release_created }}
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -0,0 +1,3 @@
+{
+  ".": "3.0.1"
+}
diff --git a/.yardopts b/.yardopts
@@ -7,5 +7,4 @@
 README.md
 CHANGELOG.md
 CONTRIBUTING.md
-RELEASING.md
 MAINTAINERS.md
diff --git a/RELEASING.md b/RELEASING.md
diff --git a/Rakefile b/Rakefile
@@ -58,3 +58,10 @@ task :'test:gem' => :install do
 
   puts 'Gem Test Succeeded'
 end
+
+# Make it so that calling `rake release` just calls `rake release:rubygem_push` to
+# avoid creating and pushing a new tag.
+
+Rake::Task['release'].clear
+desc 'Customized release task to avoid creating a new tag'
+task release: 'release:rubygem_push'
diff --git a/release-please-config.json b/release-please-config.json
@@ -0,0 +1,36 @@
+{
+  "bootstrap-sha": "31374263eafea4e23352494ef4f6bea3ce62c1b5",
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "git",
+      "changelog-path": "CHANGELOG.md",
+      "version-file": "lib/git/version.rb",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": true,
+      "draft": false,
+      "prerelease": false,
+      "include-component-in-tag": false,
+      "pull-request-title-pattern": "chore: release v${version}",
+      "changelog-sections": [
+        { "type": "feat",     "section": "Features",      "hidden": false },
+        { "type": "fix",      "section": "Bug Fixes",     "hidden": false },
+        { "type": "build",    "section": "Other Changes", "hidden": false },
+        { "type": "chore",    "section": "Other Changes", "hidden": false },
+        { "type": "ci",       "section": "Other Changes", "hidden": false },
+        { "type": "docs",     "section": "Other Changes", "hidden": false },
+        { "type": "perf",     "section": "Other Changes", "hidden": false },
+        { "type": "refactor", "section": "Other Changes", "hidden": false },
+        { "type": "revert",   "section": "Other Changes", "hidden": false },
+        { "type": "style",    "section": "Other Changes", "hidden": false },
+        { "type": "test",     "section": "Other Changes", "hidden": false }
+      ]
+    }
+  },
+  "plugins": [
+    {
+      "type": "sentence-case"
+    }
+  ],
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}