From e4de9b3f3004a84394953abf24c6bc3dbe84851f Mon Sep 17 00:00:00 2001 From: Stavros Ntentos <133706+stdedos@users.noreply.github.com> Date: Wed, 2 Oct 2024 12:43:07 +0300 Subject: [PATCH] `README.md`: Mention link to supported Ruby versions for GitHub-hosted runners Fixes https://github.com/ruby/setup-ruby/issues/650 Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com> --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4923ccec7..0637b7123 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby: | `truffleruby` | 19.3.0 - 24.1.0, head | | `truffleruby+graalvm` | 21.2.0 - 24.1.0, head | +The combinations of the available versions and runners can be seen here: https://github.com/ruby/ruby-builder/releases/tag/toolcache + `ruby-debug` is the same as `ruby-head` but with assertions enabled (`-DRUBY_DEBUG=1`). Regarding Windows ruby master builds, `mingw` is a MSYS2/MinGW build, `head` & `ucrt` are MSYS2/UCRT64 @@ -176,8 +178,8 @@ This action provides a way to automatically run `bundle install` and cache the r Note that any step doing `bundle install` (for the root `Gemfile`) or `gem install bundler` can be removed with `bundler-cache: true`. -This caching speeds up installing gems significantly and avoids too many requests to RubyGems.org. -It needs a `Gemfile` (or `$BUNDLE_GEMFILE` or `gems.rb`) under the [`working-directory`](#working-directory). +This caching speeds up installing gems significantly and avoids too many requests to RubyGems.org. +It needs a `Gemfile` (or `$BUNDLE_GEMFILE` or `gems.rb`) under the [`working-directory`](#working-directory). If there is a `Gemfile.lock` (or `$BUNDLE_GEMFILE.lock` or `gems.locked`), `bundle config --local deployment true` is used. To use a `Gemfile` which is not at the root or has a different name, set `BUNDLE_GEMFILE` in the `env` at the job level @@ -191,7 +193,7 @@ They should be set in the `env` at the job level as shown in the [example](#matr To find the correct the environment variable name, see the [Bundler docs](https://bundler.io/man/bundle-config.1.html) or look at `.bundle/config` after running `bundle config --local KEY VALUE` locally. You might need to `"`-quote the environment variable name in YAML if it has unusual characters like `/`. -To perform caching, this action will use `bundle config --local path $PWD/vendor/bundle`. +To perform caching, this action will use `bundle config --local path $PWD/vendor/bundle`. Therefore, the Bundler `path` should not be changed in your workflow for the cache to work (no `bundle config path`). #### How it Works