Configure gem and crate release automation by alexcrocha · Pull Request #1036 · Shopify/rubydex

alexcrocha · 2026-09-03T05:36:10Z

This PR does 2 things:

Centralizes gem and crate versions by making the Cargo workspace the source of truth. This allows us to automate releases to both RubyGems and crates.io.
Extends the existing release workflow for trusted publishing on crates.io.

Before this PR merges, we will need to complete the setup of trusted publishing on crates.io before our next release. The steps needed for both rubydex and rubydex-sys are:

Open Settings → Trusted Publishing
Add a GitHub Actions publisher with:
- Owner: Shopify
- Repository: rubydex
- Workflow: release.yml
- Environment: release

vinistock

Have we already configured trusted publishing in crates.io?

vinistock · 2026-09-04T14:24:33Z

+[workspace.dependencies]
+rubydex = { version = "=0.4.1", path = "rubydex" }


Why do we need this entry? I'm not sure I understand what it does.

This is a dependency of rubydex-sys that I moved here as a convenience so there was only one file to update when bumping the version. As discussed offline, I moved it back to rubydex-sys/Cargo.toml

vinistock · 2026-09-04T14:26:34Z

+   rubydex = { version = "=X.Y.Z", path = "rubydex" }
+   ```
+
+   The Ruby gem dynamically reads its version from this manifest, so do not edit `lib/rubydex/version.rb`. For pre-release versions, Cargo requires a SemVer prerelease identifier such as `X.Y.Z-beta.N`, which `lib/rubydex/version.rb` translates to `X.Y.Z.betaN` for RubyGems.


I think a lot of this sentence is an implementation detail and not really instructions for releasing.

Let's tailor this section specifically for the instructions:

Bump the version here. This controls the versions of all crates and the Ruby gem

If you want to ship a beta release, use the format 1.2.3-beta.1

👍 updated as suggested

vinistock · 2026-09-04T14:28:44Z

+in `.github/workflows/release.yml`. That workflow verifies that the tag matches
+the declared version, cross-compiles the precompiled gems, runs install
+verification, publishes to RubyGems, publishes the workspace crates to
+crates.io, and creates the GitHub release. You can trigger a dry run with
+workflow dispatch; only tag pushes publish a release.


Similar here. Are these internal details or relevant instructions for someone trying to release?

I'd honestly not add anything here. If someone tries to push a tag that doesn't match the version, they will notice the mistake.

I added a mention that it publishes to crates.io as well, and took the opportunity to simplified here

vinistock · 2026-09-04T14:30:28Z

+      - name: "Verify exact workspace dependency versions"
+        run: |
+          metadata="$(cargo metadata --no-deps --format-version 1 --manifest-path rust/Cargo.toml)"
+          ruby -rjson -e '
+            metadata = JSON.parse($stdin.read)
+            packages = metadata.fetch("packages")
+            rubydex = packages.find { |package| package.fetch("name") == "rubydex" }
+            rubydex_sys = packages.find { |package| package.fetch("name") == "rubydex-sys" }
+            requirement = rubydex_sys.fetch("dependencies").find { |dependency| dependency.fetch("name") == "rubydex" }.fetch("req")
+            expected = "=#{rubydex.fetch("version")}"
+
+            if requirement != expected
+              abort "rubydex-sys requires rubydex #{requirement.inspect}; expected #{expected.inspect}"
+            end
+          ' <<<"$metadata"


What is this check protecting us from?

This was a defensive check to make sure the dependency version was pinned to the crate version.
It's overkill; removed.

vinistock

A few questions, but the general automation looks good. Let's get it configured on the crates io side and ship 🚀

vinistock · 2026-09-10T13:19:08Z

+        with:
+          ruby-version: "3.2.9"


Does this need to run on Ruby 3.2.9? If not, we can just remove this and it will pick up the version specified in .ruby-version.

Makes sense to me 👍

vinistock · 2026-09-10T13:21:20Z

+        with:
+          ruby-version: "3.2.9"
+      - name: "Verify the tag matches the declared version"
+        if: startsWith(github.ref, 'refs/tags/')


Should we match the other similar checks?

Suggested change

if: startsWith(github.ref, 'refs/tags/')

if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')

vinistock · 2026-09-10T13:22:37Z

+          fi
  compile:
    timeout-minutes: 20
+    needs: verify_version


Here we're adding a needs requirement to an optional step (since verify_version doesn't run if you trigger the workflow manually for debugging instead of releasing).

Will this work properly if verify_version is skipped by the conditional? Or will the entire workflow get stuck?

This is a fair question. The condition is on the step, not on the job. So the verify_version job will run and complete regardless of the conditional step being true or not.

But now that you point it out, the previous steps will always run and that's wasteful.

I will look into an alternative approach for this

vinistock · 2026-09-10T13:23:26Z

+    permissions:
+      id-token: write
+      contents: read
+    timeout-minutes: 30


30 minutes seems like a lot for just publishing the crates. Maybe 5 is fine?

vinistock · 2026-09-10T13:25:29Z


 [dependencies]
-rubydex = { version = "0.2.6", path = "../rubydex" }
+rubydex = { version = "=0.4.1", path = "../rubydex" }


Did you confirm that if we bump the version in rust/Cargo.toml and forget to bump it here, it fails compilation?

Yes, it fails immediately with

error: failed to select a version for the requirement `rubydex = "=0.4.1"` candidate versions found which didn't match: 0.4.2

alexcrocha self-assigned this Sep 3, 2026

alexcrocha force-pushed the ar-release-workflow branch from f10f932 to 4c7dfff Compare September 3, 2026 05:51

alexcrocha marked this pull request as ready for review September 4, 2026 06:30

alexcrocha requested a review from a team as a code owner September 4, 2026 06:30

alexcrocha added the chore Something that should not be included in release notes label Sep 4, 2026

vinistock reviewed Sep 4, 2026

View reviewed changes

alexcrocha force-pushed the ar-release-workflow branch from a31cc11 to 5eb7324 Compare September 9, 2026 23:02

alexcrocha added 3 commits September 9, 2026 16:46

Centralize gem and crate versions in the Cargo workspace

1f4ba93

Configure gem and crate release automation

bdd48cb

Restrict release workflow permissions

986902c

alexcrocha force-pushed the ar-release-workflow branch from 5eb7324 to 986902c Compare September 9, 2026 23:47

vinistock approved these changes Sep 10, 2026

View reviewed changes

		[workspace.dependencies]
		rubydex = { version = "=0.4.1", path = "rubydex" }

	if: startsWith(github.ref, 'refs/tags/')
	if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')

Uh oh!

Conversation

alexcrocha commented Sep 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vinistock left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexcrocha Sep 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vinistock left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexcrocha Sep 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alexcrocha commented Sep 3, 2026 •

edited

Loading

alexcrocha Sep 9, 2026 •

edited

Loading

alexcrocha Sep 11, 2026 •

edited

Loading