Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

setup-ruby-pkgs

Cross platform action that installs Ruby, along with tools and packages needed for compiling.

If you don't need any changes to tools or packages, please use ruby/setup-ruby.

The action's inputs are shown below:

- uses: MSP-Greg/setup-ruby-pkgs@v1
  with:
    ruby-version:
    bundler:
    apt:             # Ubuntu
    brew:            # macOS
    mingw:           # Windows mingw / mswin
    msys2:           #         mingw
    mswin:           # Windows mswin
    choco:           #         mswin
    vcpkg:           #         mswin

Input Information

All inputs are optional.

ruby-version:

Installs the Ruby version using the code from ruby/setup-ruby. The available versions can be found in its README.

bundler:

Installs Bundler using the code from ruby/setup-ruby.

apt: (Ubuntu)

List of packages to install. Space delimited. Special options are _update_, _upgrade_, and _dist-upgrade_.

If _upgrade_ or _dist-upgrade_ are included, _update_ will also be done.

If neither is included and you're just installing package(s), _update_ WILL NOT BE DONE unless it's included.

brew: (macOS)

List of packages to install. Space delimited. Special options are _update_ and _upgrade_, and both work similar to apt-get:.

mingw: (Windows)

Ruby 2.4 & later
List of MSYS2 MinGW packages to install. Space delimited. The package prefix (mingw-w64-x86_64-) is not required.
If _upgrade_ is included in the input, all packages needed by the gcc tools are updated.
If openssl is included, an appropriate package will be installed.
Ruby 2.3 & earlier
The following DevKit packages are available:
  • libffi-3.2.1
  • openssl-1.0.2j
  • ragel-6.7
  • sqlite-3.7.15.2 (sqlite3)
  • zlib-1.2.8
Ruby mswin
If openssl is included, it will be installed for mswin as a convenience.
Likewise, if ragel is included, the MSYS2 ragel package will be installed.

msys2: (Windows)

Ruby 2.4 & later
List of MSYS2 packages to install. Space delimited. These are command line utilities, and are rarely needed.
Ruby 2.3 & earlier
No action, as no utilities are available for the older MSYS/DevKit.

mswin: (Windows)

Installs MSYS2 packages. These are typically build utilities, such as bison, ragel, etc. As in pacman, MinGW packages must be prefixed with mingw-w64-x86_64-.

choco: (Windows)

List of packages to install. Space delimited. Most packages are compiled with msvc, so normally used with mswin builds.

vcpkg: (Windows)

List of packages to install. Space delimited. All packages are compiled with msvc, so normally used with mswin builds. An environment variable OPT_DIR is set to

"--with-opt-dir=#{ENV['VCPKG_INSTALLATION_ROOT']}/installed/x64-windows"

After install, the tools folder is checked, and if any files are present, it is added to path.

Ruby and Windows

For additional information see Ruby and Windows