Skip to content

ruby/setup-ruby

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

setup-ruby

Note: this action used to be at eregon/use-ruby-action and was moved to the ruby organization.

This action downloads a prebuilt ruby and adds it to the PATH.

It is very efficient and takes about 5 seconds to download, extract and add the given Ruby to the PATH. No extra packages need to be installed.

Compared to actions/setup-ruby, this actions supports many more versions and features.

Supported Versions

This action currently supports these versions of MRI, JRuby and TruffleRuby:

Interpreter Versions
Ruby 2.3.0 - 2.3.8, 2.4.0 - 2.4.9, 2.5.0 - 2.5.7, 2.6.0 - 2.6.5, 2.7.0, head
JRuby 9.2.9.0
TruffleRuby 19.3.0, 19.3.1, head
Rubinius 4.14

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

Rubinius is only available on ubuntu-latest.

The prebuilt releases are generated by ruby-builder and on Windows by RubyInstaller2. ruby-head is generated by ruby-dev-builder and truffleruby-head is generated by truffleruby-dev-builder. The full list of available Ruby versions can be seen in ruby-builder-versions.js for Ubuntu and macOS and in windows-versions.js for Windows.

Usage

Single Job

name: My workflow
on: [push]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout