From 26cdcd04889e215389b377ba2622341c0ee7ba4e Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Fri, 17 Jan 2020 15:42:28 +0100 Subject: [PATCH] Clarify the supported versions and intended usage --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4e58714b..3cc1c477 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,17 @@ GitHub Actions status

-This action sets up a ruby environment for use in actions by: +This action sets up Ruby for use in actions by adding a version of Ruby already existing in the toolcache to the PATH. -- optionally installing a version of ruby and adding to PATH. Note that this action only uses versions of Ruby already installed in the cache. The action will fail if no matching versions are found. -- registering problem matchers for error output +This action currently only supports versions of Ruby in the toolcache. +See [this list](https://github.com/actions/virtual-environments/blob/master/images/linux/Ubuntu1804-README.md) for the available Ruby versions. +The action will fail if no matching versions are found. + +Because versions in the toolcache are updated over time, it is necessary to use a version range such as `2.6.x` and not exact versions. + +If you are looking for using exact versions (e.g., `2.6.5`) of Ruby, +please take a look at other actions such as [use-ruby-action](https://github.com/eregon/use-ruby-action). +Note that there are [plans](https://github.com/actions/setup-ruby/issues/44) to support installing prebuilt Rubies with this action in the future. # Usage