cross-gem-action's Introduction

Cross Gem Action

This action makes it easy to compile and package native Rubygems that are written in Rust. Under the hood, it uses a customized version rake-compiler-dock to compile a gem, and is meant to be used in tandem with rb-sys.

Table of Contents

Example workflow
Inputs
License

Example workflow

# Adjust this based on your release workflow
on:
  workflow_dispatch:

jobs:
  native_gem:
    name: Compile native gem
    runs-on: ubuntu-latest
    strategy:
      matrix:
        platform:
          - x86_64-linux
          - aarch64-linux
          - arm-linux
          - x86_64-darwin
          - arm64-darwin
          - x64-mingw32
          - x64-mingw-ucrt
    steps:
      - uses: actions/checkout@v2

      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: '3.1'
          bundler-cache: true

      - uses: oxidize-rb/cross-gem-action@main
        with:
          platform: ${{ matrix.platform }}
          version: '0.9.27' # optional
          setup: | # optional
            echo "Do something custom before compiling..."
          env: | # optional
            RUBY_CC_VERSION=3.1.0:3.0.0:2.7.0
            SOME_OTHER_ENV=some_value

      - uses: actions/download-artifact@v3
        with:
          name: cross-gem
          path: pkg/

      - name: Display structure of built gems
        run: ls -R
        working-directory: pkg/

Inputs

Name	Description	Type	Default
`platform`	Target Ruby platform	string
`directory`	Directory of the Rakefile	string
`env`	Extra env to set in the container	string
`setup`	Custom setup script for the container	string
`version`	Version tag for the docker image to use	string	latest rb-sys version