Add a workflow:

- This creates the whole dance of:

  1. Run the packaging for all platforms. This basically creates the
     `*.gem` file with the precompiled binaries. This allow us to save
     time by doing everything in one go. The whole thing is then
     uploaded and the zip includes the gem ready to be released but also
     the binaries that we'll use to run the test suite agains.
  2. We download the tarball, move all the compiled binaries for a platform
     inside the gem require paths. The test suite then runs against the
     compiled binaries.
     We also run the test suite by compiling once more, this time using the
     currently running ruby version.

     This basically allow to test the `require "#{ruby_version}/date_core.so"`
     as well as the `require "date_core.so"` when a user will be downloading
     the gem for a platform we didn't compile with.
  3. We make sure `gem install` on the `.gem` works
  4. We release the gems

- Lot of cleanup but I'll take care of that in another PR.

Author: Edouard-chin

.github/actions/easy_compile/action.yml

@@ -6,39 +6,76 @@ inputs:
     description: "The working directory of the gem"
     default: "."
     required: false
+  step:
+    description: "The step to run"
+    required: true
+  token:
+    description: "Not important" # TODO Remove this. I only need that for testing purposes
+    required: false
 
 runs:
   using: "composite"
   steps:
-    - name: Checkout easy compile
+    - name: Checkout easy compile # TODO this can be removed once this tool is pusblished on RubyGems
       uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
       with:
         path: "tmp"
         repository: "shopify-playground/edouard-playground"
-    - name: Install easy compile
+    - name: Install easy compile # TODO this can be removed once this tool is pusblished on RubyGems
       shell: bash
       run: "rake install"
       working-directory: "tmp"
-    - name: Compile and test
-      working-directory: ${{ inputs.working-directory }}
-      shell: bash
-      run: easy_compile
     - name: "Setup Rake Compiler"
+      if: "${{ inputs.step == 'compile' }}"
       uses: actions/github-script@v8
       with:
         script: |
           const url = new URL(`file:///${process.env.GITHUB_ACTION_PATH}/dist/index.js`);
           const { run } = await import(url.href)
           await run('${{ inputs.working-directory }}')
-    - name: Package gems with precompiled binaries
+    - name: Package
+      if: "${{ inputs.step == 'compile' }}"
       working-directory: ${{ inputs.working-directory }}
       shell: bash
-      run: easy_compile clobber && easy_compile package
+      run: easy_compile package
     - name: Upload artifacts
+      if: "${{ inputs.step == 'compile' }}"
       uses: actions/upload-artifact@v4
       with:
-        name: "package-${{ runner.os }}-${{ runner.arch }}"
-        path: "${{ inputs.working-directory }}/pkg/*.gem"
+        name: "stage-${{ runner.os }}-${{ runner.arch }}"
+        path: |
+          ${{ inputs.working-directory }}/tmp/**/*.so
+          ${{ inputs.working-directory }}/tmp/**/*.bundle
+          ${{ inputs.working-directory }}/pkg/*.gem
         if-no-files-found: error
-        overwrite: true
         retention-days: 1
+    - name: "Download compiled binaries"
+      if: "${{ inputs.step == 'test_cross' }}"
+      uses: actions/download-artifact@v5
+      with:
+        name: "stage-${{ runner.os }}-${{ runner.arch }}"
+        path: "${{ inputs.working-directory }}"
+    - name: "Copy staging binary to the libdir"
+      if: "${{ inputs.step == 'test_cross' }}"
+      working-directory: ${{ inputs.working-directory }}
+      shell: bash
+      run: easy_compile copy_from_staging_to_lib
+    - name: "Compile native"
+      if: "${{ inputs.step == 'test_native' }}"
+      working-directory: ${{ inputs.working-directory }}
+      shell: bash
+      run: easy_compile compile
+    - name: "Execute the tests"
+      if: "${{ startsWith(inputs.step, 'test') }}"
+      working-directory: ${{ inputs.working-directory }}
+      shell: bash
+      run: bundle exec rake test # TODO This should be configurable
+    - name: "Download gems"
+      if: "${{ inputs.step == 'install' }}"
+      uses: actions/download-artifact@v5
+      with:
+        name: "stage-${{ runner.os }}-${{ runner.arch }}"
+    - name: "Install gems"
+      if: "${{ inputs.step == 'install' }}"
+      shell: bash
+      run: gem install pkg/*.gem

.github/actions/easy_publish/action.yml

@@ -6,6 +6,9 @@ inputs:
     description: "The working directory of the gem"
     default: "."
     required: false
+  token:
+    description: "Not important" # TODO No need for this. Only for testing purposes
+    required: false
 
 runs:
   using: "composite"
@@ -21,7 +24,11 @@ runs:
       working-directory: "tmp"
     - uses: actions/download-artifact@v5
       with:
-        path: "${{ inputs.working-directory }}/pkg"
+        artifact-ids: 4283005309,4283005567
+        run-id: 18545927463
+        github-token: "${{ inputs.token }}"
+        path: "${{ inputs.working-directory }}"
+        # path: "${{ inputs.working-directory }}/pkg"
         merge-multiple: true
     - name: "Release"
       uses: Edouard-chin/release-gem@ec-working-dir

.github/workflows/gem-compile.yml

@@ -1,23 +1,97 @@
 name: "Compile and test the date gem"
 on: [push]
 jobs:
-  compile_and_test:
-    name: "Complile and test the date gem"
+  compile:
+    timeout-minutes: 10 # TODO This should be configurable
+    name: "Cross compile the gem on different ruby versions"
     strategy:
       matrix:
-        version: ["3.4.4"]
-        os: ["ubuntu-latest"]
+        os: ["ubuntu-latest", "macos-latest"]
     runs-on: "${{ matrix.os }}"
     steps:
       - name: "Checkout code"
         uses: "actions/checkout@v5"
       - name: "Setup Ruby"
         uses: "ruby/setup-ruby@v1"
         with:
-          ruby-version: "${{ matrix.version }}"
+          ruby-version: "3.4.7" # TODO This should be determined dynamically.
           bundler-cache: true
           working-directory: "test/fixtures/date"
       - name: "Run easy compile"
         uses: "./.github/actions/easy_compile"
         with:
           working-directory: "test/fixtures/date"
+          step: "compile"
+  test:
+    permissions: # TODO This can be removed. I just need this temporarily to download the artifact from a previous workflow
+      actions: read
+      contents: read
+    timeout-minutes: 10 # TODO This should be configurable
+    name: "Run the test suite"
+    needs: compile
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "macos-latest"]
+        rubies: ["3.0.7", "3.1.7", "3.2.9", "3.3.9", "3.4.6"] # TODO This should be determined dynamically.
+        type: ["cross", "native"]
+    runs-on: "${{ matrix.os }}"
+    steps:
+      - name: "Checkout code"
+        uses: "actions/checkout@v5"
+      - name: "Setup Ruby"
+        uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: "${{ matrix.rubies }}"
+          bundler-cache: true
+          working-directory: "test/fixtures/date"
+      - name: "Run easy compile"
+        uses: "./.github/actions/easy_compile"
+        with:
+          working-directory: "test/fixtures/date"
+          step: "test_${{ matrix.type }}"
+          token: ${{ secrets.GITHUB_TOKEN }} # TODO This can be removed. Only for testing
+  install:
+    permissions: # TODO This can be removed. I just need this temporarily to download the artifact from a previous workflow
+      actions: read
+      contents: read
+    timeout-minutes: 5
+    name: "Verify the gem can be installed"
+    needs: test
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "macos-latest"]
+    runs-on: "${{ matrix.os }}"
+    steps:
+      - name: "Checkout code" # TODO No need to checkout the codebase. Have to do it here because the relative path to the action doesn't work otherwise.
+        uses: "actions/checkout@v5"
+      - name: "Setup Ruby"
+        uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: "3.4.7" # TODO This needs to be determined dynamically.
+      - name: "Run easy compile"
+        uses: "./.github/actions/easy_compile"
+        with:
+          step: "install"
+  release:
+    permissions: # TODO This can be removed. I just need this temporarily to download the artifact from a previous workflow
+      actions: read
+      contents: read
+      id-token: write
+    timeout-minutes: 5
+    name: "Release all gems with RubyGems"
+    needs: install
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Checkout code" # TODO No need to checkout the codebase. Have to do it here because the relative path to the action doesn't work otherwise.
+        uses: "actions/checkout@v5"
+      - name: "Setup Ruby"
+        uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: "3.4.7"
+          bundler-cache: true
+          working-directory: "test/fixtures/date"
+      - name: "Run easy compile"
+        uses: "./.github/actions/easy_publish"
+        with:
+          working-directory: "test/fixtures/date"
+          token: "${{ secrets.GITHUB_TOKEN }}"

Rakefile

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
 
 task default: :test

easy_compile.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "Add a description laster"
   spec.homepage = "https://github.com"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["homepage_uri"] = spec.homepage

lib/easy_compile/cli.rb

@@ -15,18 +15,30 @@ def self.exit_on_failure?
       true
     end
 
-    desc "compile_and_test", "Compile a gem's native extension based on its gemspec and run the test suite."
-    def compile_and_test
+    desc "compile", "Compile a gem's native extension based on its gemspec."
+    def compile
       run_rake_tasks!(:compile)
     end
 
+    desc "compile_cross_rubies", "Compile a gem's native extension based on its gemspec."
+    def compile_cross_rubies
+      ENV["RUBY_CC_VERSION"] ||= compilation_task.ruby_cc_version
+
+      run_rake_tasks!(:cross, :compile)
+    end
+
     desc "package", "Package the gem and its extension"
     def package
       ENV["RUBY_CC_VERSION"] ||= compilation_task.ruby_cc_version
 
       run_rake_tasks!(:cross, :native, :gem)
     end
 
+    desc "copy_from_staging_to_lib", "Copy the staging binary"
+    def copy_from_staging_to_lib
+      run_rake_tasks!("copy:stage:lib")
+    end
+
     desc "clean", "Cleanup compilation artifacts."
     def clean
       run_rake_tasks!(:clean)

lib/easy_compile/compilation_tasks.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
 require "bundler"
-require "rubygems/gemspec_helpers"
 require "rubygems/package_task"
 require "rake/extensiontask"
 
 module EasyCompile
   class CompilationTasks
-    include Gem::GemspecHelpers
-
-    attr_reader :gemspec, :native, :create_packaging_task
+    attr_reader :gemspec, :native, :create_packaging_task, :extension_task
     attr_accessor :binary_name
 
     def initialize(create_packaging_task = false, gemspec = nil)
@@ -64,7 +61,7 @@ def with_mkmf_monkey_patch
     def define_task(path)
       require File.expand_path(path)
 
-      Rake::ExtensionTask.new do |ext|
+      @extension_task = Rake::ExtensionTask.new do |ext|
         ext.name = File.basename(binary_name)
         ext.config_script = File.basename(path)
         ext.ext_dir = File.dirname(path)
@@ -124,5 +121,9 @@ def cross_rubies
 
      versions.map { |version| Gem::Version.new(version) }
     end
+
+    def find_gemspec(glob = "*.gemspec")
+      Dir.glob(glob).sort.first
+    end
   end
 end

lib/easy_compile/tasks/wrapper.rake

@@ -4,3 +4,10 @@ require_relative "../compilation_tasks"
 
 task = EasyCompile::CompilationTasks.new(!Rake::Task.task_defined?(:package))
 task.setup
+
+task "copy:stage:lib" do
+  version = RUBY_VERSION.match(/(\d\.\d)/)[1]
+  path = "#{task.extension_task.lib_dir}/#{version}"
+
+  cp_r("tmp/#{task.extension_task.cross_platform}/stage/#{path}", path, remove_destination: true)
+end