ruby operation

Installs ruby to be used by the current repository.

note

Omni uses asdf in the background to manage that tool. The asdf installation of omni is in its own directory, and won't conflict with any installation of asdf you might have on your system.

Parameters

The following parameters can be used:

Parameter	Type	Description
dir	path	Relative path (or list of relative paths) to the directory in the project for which to use the node version
url	string	The URL to download the tool from, in case the tool is not registered in asdf-plugins or if you want to use a custom version.
version	string	The version of the tool to install; see version handling below for more details.
upgrade	boolean	whether or not to always upgrade to the most up to date matching version, even if an already-installed version matches the requirements (default: false)

Version handling

The following strings can be used to specify the version:

Version	Meaning
1.2	Accepts 1.2 and any version prefixed by 1.2.*
1.2.3	Accepts 1.2.3 and any version prefixed by 1.2.3.*
~1.2.3	Accepts 1.2.3 and higher patch versions (1.2.4, 1.2.5, etc. but not 1.3.0)
^1.2.3	Accepts 1.2.3 and higher minor and patch versions (1.2.4, 1.3.1, 1.4.7, etc. but not 2.0.0)
>1.2.3	Must be greater than 1.2.3
>=1.2.3	Must be greater or equal to 1.2.3
<1.2.3	Must be lower than 1.2.3
<=1.2.3	Must be lower or equal to 1.2.3
1.2.x	Accepts 1.2.0, 1.2.1, etc. but will not accept 1.3.0
*	Matches any version (same as latest, except that when upgrade is false, will match any installed version)
latest	Latest release (when upgrade is set to false, will only match with installed versions of the latest major)
auto	Lookup for any version files in the project directory (.tool-versions or .ruby-version) and apply version parsing

The version also supports the || operator to specify ranges. This operator is not compatible with the latest and auto keywords. For instance, 1.2.x || >1.3.5 <=1.4.0 will match any version between 1.2.0 included and 1.3.0 excluded, or between 1.3.5 excluded and 1.4.0 included.

The latest version satisfying the requirements will be installed.

Examples

up:
  # Will install the latest version of ruby
  - ruby

  # And also
  - ruby: latest

  # Let omni lookup for version files in the project
  - ruby: auto

  # Will install any version starting with 3.2, and containing
  # only dots and numbers after
  - ruby: 3.2

  # Will install any version starting with 3, and containing only
  # dots and numbers after
  - ruby: 3

  # Full specification of the parameter to identify the version;
  # this will install any version starting with 3.2.2, and
  # containing only dots and numbers after
  - ruby:
      version: 3.2.2

  # Use that version but only in the some/sub/dir directory
  - ruby:
      version: 3.2.2
      dir: some/sub/dir

Dynamic environment

The following variables will be set as part of the dynamic environment.

Environment variable	Operation	Description
GEM_HOME	set	The location of the gems for the loaded version of ruby
GEM_ROOT	set	The location of the gems for the loaded version of ruby
RUBY_ENGINE	set	ruby
RUBY_ROOT	set	The location of the ruby root for the loaded version of ruby
RUBY_VERSION	set	The loaaded version of ruby
GEM_PATH	prepend	The location of the gems for the loaded version of ruby
PATH	prepend	The bin directory of the gems for the loaded version of ruby
PATH	prepend	The bin directory for the loaded version of ruby