4. Workflow reference

Cibuildgem GitHub action

During the generation of the workflow file, you'll notice that the workflow uses a cibuildgem action.

- name: "Run cibuildgem"
  uses: "shopify/cibuildgem/.github/actions/cibuildgem@main"
  with:
    step: "compile"

This page outlines the option supported by the action.

- uses: shopify/cibuildgem/.github/actions/cibuildgem@main
  with:
    # The directory where you gem is located in the repository. This is only needed if your gem is not at the root.
    working-directory: ''
    
    # The phase to run. Can be either [compile, test_native, test_cross, install, release].
    # The compile step, runs the compilation and packaging.
    # The test_native step, runs the test suite and runs the compilation
    # The test_cross step, runs the test suite and uses the binary compiled during the compile step
    # The install step verifies if the gem packaged in the compile step are installable
    # The release step relases the gems to RubyGems.org
    step: ''

    # The test command to run the gem test suite. If none is provided cibuildgem will try to find a rake task that is either named
    # test or spec.
    test-command: ''