Note that Ruby 2.3 and the OpenSSL version it needs (1.0.2) are both end-of-life, which means Ruby 2.3 is unmaintained and considered insecure. On Windows, Ruby 2.4 uses OpenSSL 1.0.2, which is no longer maintained.

Supported Platforms

The action works for all GitHub-hosted runners.

Operating System	Versions
Ubuntu	`ubuntu-latest` (= `ubuntu-18.04`), `ubuntu-16.04`
macOS	`macos-latest`
Windows	`windows-latest`

The prebuilt rubies are generated by eregon/ruby-install-builder and on Windows by RubyInstaller2.
The full list of available Ruby versions can be seen at versions.json for Ubuntu and macOS and at ruby-installer-versions.js for Windows.

Usage

Single Job

name: My workflow
on: [push]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: eregon/use-ruby-action@v1
      with:
        ruby-version: 2.6
    - run: ruby -v

Matrix

This matrix tests all stable releases of MRI, JRuby and TruffleRuby on Ubuntu and macOS.

name: My workflow
on: [push]
jobs:
  test:
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, macos-latest ]
        ruby: [ 2.4, 2.5, 2.6, 2.7, jruby, truffleruby ]
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v2
    - uses: eregon/use-ruby-action@v1
      with:
        ruby-version: ${{ matrix.ruby }}
    - run: ruby -v

Supported Version Syntax

engine-version like ruby-2.6.5 and truffleruby-19.3.0
short version like 2.6, automatically using the latest release matching that version (2.6.5)
version only like 2.6.5, assumes MRI for the engine
engine only like truffleruby, uses the latest stable release of that implementation
.ruby-version (also the default value) reads from the project's .ruby-version file

Bundler

Currently, Bundler is guaranteed to be installed for all versions. If the Ruby ships with Bundler (Ruby >= 2.6), that version is used. Otherwise (Ruby < 2.6), Bundler 1 is installed when that Ruby was built.

Caching `bundle install`

You can cache the installed gems with these two steps:

    - uses: actions/cache@v1
      with:
        path: vendor/bundle
        key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
        restore-keys: |
          bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-
    - name: Bundle install
      run: |
        bundle config path vendor/bundle
        bundle install --jobs 4 --retry 3

When using a single job with a Ruby version, replace ${{ matrix.ruby }} with the Ruby version.
When using .ruby-version, replace ${{ matrix.ruby }} with ${{ hashFiles('.ruby-version') }}.

This uses the cache action. The code above is a more complete version of the Ruby - Gem example. Make sure to include use-ruby in the key to avoid conflicting with previous caches.

Limitations

This action currently only works with GitHub-hosted runners, not private runners.

Versioning

This action follows semantic versioning with a moving v1 branch. This follows the recommendations of GitHub Actions.

Credits

Most of the Windows logic is from https://github.com/MSP-Greg/actions-ruby by MSP-Greg.

README.md

use-ruby-action

Supported Versions