Merge pull request #50 from zendesk/trusted_publishing

Switch to trusted publishing workflow and run it on version.rb changes

Author: razumau

.github/workflows/publish.yml

@@ -1,12 +1,26 @@
-name: Publish Gem
+name: Publish to RubyGems.org
 
 on:
   push:
-    tags: v*
+    branches: main
+    paths: lib/migration_tools/version.rb
+  workflow_dispatch:
 
 jobs:
-  call-workflow:
-    uses: zendesk/gw/.github/workflows/ruby-gem-publication.yml@main
-    secrets:
-      RUBY_GEMS_API_KEY: ${{ secrets.RUBY_GEMS_API_KEY }}
-      RUBY_GEMS_TOTP_DEVICE: ${{ secrets.RUBY_GEMS_TOTP_DEVICE }}
+  publish:
+    runs-on: ubuntu-latest
+    environment: rubygems-publish
+    if: github.repository_owner == 'zendesk'
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: false
+          
+      - name: Install dependencies
+        run: bundle install
+      - uses: rubygems/release-gem@v1

README.md

@@ -30,7 +30,6 @@ The names of the possible groups are predefined to avoid turning this solution i
 
 *change* this is a special group that you run whenever you want to change DB data which you'd otherwise do in script/console
 
-
 ## Commands
 
 The list commands
@@ -54,6 +53,21 @@ The group commands
 ```
 Note that rake db:migrate is entirely unaffected by this.
 
+### Releasing a new version
+A new version is published to RubyGems.org every time a change to `version.rb` is pushed to the `main` branch.
+In short, follow these steps:
+1. Update `version.rb`,
+2. update version in all `Gemfile.lock` files,
+3. merge this change into `main`, and
+4. look at [the action](https://github.com/zendesk/migration_tools/actions/workflows/publish.yml) for output.
+
+To create a pre-release from a non-main branch:
+1. change the version in `version.rb` to something like `1.2.0.pre.1` or `2.0.0.beta.2`,
+2. push this change to your branch,
+3. go to [Actions → “Publish to RubyGems.org” on GitHub](https://github.com/zendesk/migration_tools/actions/workflows/publish.yml),
+4. click the “Run workflow” button,
+5. pick your branch from a dropdown.
+
 ## License
 
 Copyright 2015 Zendesk

lib/migration_tools/version.rb

@@ -0,0 +1,3 @@
+module MigrationTools
+  VERSION = "1.10.0"
+end

migration_tools.gemspec

@@ -1,4 +1,6 @@
-Gem::Specification.new "migration_tools", "1.10.0" do |s|
+require_relative "lib/migration_tools/version"
+
+Gem::Specification.new "migration_tools", MigrationTools::VERSION do |s|
   s.description = "Rake tasks for Rails that add groups to migrations"
   s.summary = "Encourage migrations that do not require downtime"
   s.homepage = "https://github.com/zendesk/migration_tools"