Merge pull request #92 from maxmind/greg/release-workflow

Add release workflow using trusted publishing

Author: horgh

.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Release
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - published
+
+jobs:
+  push:
+    if: github.event_name == 'release' && github.event.action == 'published'
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - uses: rubygems/release-gem@v1

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## v2.4.0
+## v2.4.0 (2024-01-12)
 
 * Ruby 2.7+ is now required. If you're using Ruby 2.5 or 2.6, please use
   version 2.3.0 of this gem.

README.dev.md

@@ -1,4 +1,28 @@
+# Prereqs
+
+* You must have a local Ruby environment that can run the tests
+  via `rake`.
+* You must have the [GitHub CLI tool (gh)](https://cli.github.com/)
+  installed, in your path, and logged into an account that can
+  make GitHub releases on the repo.
+* Your environment also must have `bash`, `git`, `perl`, and `sed`
+  available.
+
 # How to release
 
-See
-[here](https://github.com/maxmind/MaxMind-DB-Reader-ruby/blob/main/README.dev.md).
+* Review open issues and PRs to see if anything needs to be addressed
+  before release.
+* Create a branch e.g. `horgh/release` and switch to it.
+  * `main` is protected.
+* Set the release version and release date in `CHANGELOG.md`. Be sure
+  the version follows [Semantic Versioning](https://semver.org/).
+* Commit these changes.
+* Run `dev-bin/release.sh`.
+* Verify the release on the GitHub Releases page.
+* If everything goes well, the authorized releasers will receive an email
+  to review the pending deployment. If you are an authorized releaser,
+  you will need to approve the release deployment run. If you are not,
+  you will have to wait for an authorized releaser to do so.
+* Double check it looks okay at https://rubygems.org/gems/minfraud and
+  https://www.rubydoc.info/gems/minfraud.
+* Make a PR and get it merged.

dev-bin/release.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+set -eu -o pipefail
+
+changelog=$(cat CHANGELOG.md)
+
+regex='
+## v([0-9]+\.[0-9]+\.[0-9]+) \(([0-9]{4}-[0-9]{2}-[0-9]{2})\)
+
+((.|
+)*)
+'
+
+if [[ ! $changelog =~ $regex ]]; then
+      echo "Could not find date line in change log!"
+      exit 1
+fi
+
+version="${BASH_REMATCH[1]}"
+date="${BASH_REMATCH[2]}"
+notes="$(echo "${BASH_REMATCH[3]}" | sed -n -E '/^## v[0-9]+\.[0-9]+\.[0-9]+/,$!p')"
+
+echo "$notes"
+if [[ "$date" != "$(date +"%Y-%m-%d")" ]]; then
+    echo "$date is not today!"
+    exit 1
+fi
+
+tag="v$version"
+
+if [ -n "$(git status --porcelain)" ]; then
+    echo ". is not clean." >&2
+    exit 1
+fi
+
+perl -pi -e "s/(?<=VERSION = \').+?(?=\')/$version/g" lib/minfraud/version.rb
+
+echo $"Test results:"
+
+rake
+
+echo $'\nDiff:'
+git diff
+
+echo $'\nRelease notes:'
+echo "$notes"
+
+read -e -p "Commit changes and push to origin? " should_push
+
+if [ "$should_push" != "y" ]; then
+    echo "Aborting"
+    exit 1
+fi
+
+git commit -m "Update for $tag" -a
+
+git push
+
+gh release create --target "$(git branch --show-current)" -t "$version" -n "$notes" "$tag"

lib/minfraud/version.rb

@@ -2,5 +2,5 @@
 
 module Minfraud
   # The Gem version.
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

minfraud.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^.gitignore$|^(?:\.github|dev-bin|spec)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']