From f564484a579d5bc62c01b3446a044daec2dfcaac Mon Sep 17 00:00:00 2001 From: MSP-Greg Date: Wed, 10 Aug 2022 10:39:02 -0500 Subject: [PATCH] README.md updates & 'use ruby/setup-ruby@v1 --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d6eaa0e..1b4edce 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,9 @@ 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](https://github.com/actions/setup-ruby), -this actions supports many more versions and features. +**Important:** Prefer `ruby/setup-ruby@v1`. +If you pin to a commit or release, only the Ruby versions available at the time of the commit +will be available, and you will need to update it to use newer Ruby versions, see [Versioning](#versioning). ### Supported Versions @@ -14,21 +15,23 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby: | Interpreter | Versions | | ----------- | -------- | -| `ruby` | 1.9.3, 2.0.0, 2.1.9, 2.2, all versions from 2.3.0 until 3.2.0-preview1, head, debug, mingw, mswin | +| `ruby` | 1.9.3, 2.0.0, 2.1.9, 2.2, all versions from 2.3.0 until 3.2.0-preview1, head, debug, mingw, mswin, ucrt | | `jruby` | 9.1.17.0 - 9.3.7.0, head | | `truffleruby` | 19.3.0 - 22.2.0, head | | `truffleruby+graalvm` | 21.2.0 - 22.2.0, head | `ruby-debug` is the same as `ruby-head` but with assertions enabled (`-DRUBY_DEBUG=1`). -On Windows, `mingw` and `mswin` are `ruby-head` builds using the MSYS2/MinGW and the MSVC toolchains respectively. + +Regarding Windows ruby master builds, `mingw` is a MSYS2/MinGW build, `head` & `ucrt` are MSYS2/UCRT64 +builds, and `mswin` is a MSVC/VS 2022 build. Preview and RC versions of Ruby might be available too on Ubuntu and macOS (not on Windows). However, it is recommended to test against `ruby-head` rather than previews, as it provides more useful feedback for the Ruby core team and for upcoming changes. -Only versions published by [RubyInstaller](https://rubyinstaller.org/downloads/archives/) are available on Windows. -Due to that, Ruby 2.2 resolves to 2.2.6 on Windows and 2.2.10 on other platforms. -And Ruby 2.3 on Windows only has builds for 2.3.0, 2.3.1 and 2.3.3. +Only release versions published by [RubyInstaller](https://rubyinstaller.org/downloads/archives/) +are available on Windows. Due to that, Ruby 2.2 resolves to 2.2.6 on Windows and 2.2.10 +on other platforms. Ruby 2.3 on Windows only has builds for 2.3.0, 2.3.1 and 2.3.3. Note that Ruby ≤ 2.4 and the OpenSSL version it needs (1.0.2) are both end-of-life, which means Ruby ≤ 2.4 is unmaintained and considered insecure. @@ -38,14 +41,14 @@ which means Ruby ≤ 2.4 is unmaintained and considered insecure. The action works on these [GitHub-hosted runners](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners) virtual environments. Virtual environments not listed below are unsupported. | Operating System | Recommended | Other Supported Versions | -| ----------- | -------- | -------- | -| Ubuntu | `ubuntu-latest` (= `ubuntu-20.04`) | `ubuntu-18.04`, `ubuntu-22.04` | -| macOS | `macos-latest` (= `macos-11`) | `macos-10.15`, `macos-12` (beta) | +| ---------------- | ----------- | ------------------------ | +| Ubuntu | `ubuntu-latest` (= `ubuntu-20.04`) | `ubuntu-18.04`, `ubuntu-22.04` | +| macOS | `macos-latest` (= `macos-11`) | `macos-10.15`, `macos-12` | | Windows | `windows-latest` (= `windows-2022`) | `windows-2019` | The prebuilt releases are generated by [ruby-builder](https://github.com/ruby/ruby-builder) and on Windows by [RubyInstaller2](https://github.com/oneclick/rubyinstaller2). -`mingw` and `mswin` builds are generated by [ruby-loco](https://github.com/MSP-Greg/ruby-loco). +The `mingw`, `ucrt` and `mswin` builds are generated by [ruby-loco](https://github.com/MSP-Greg/ruby-loco). `ruby-head` is generated by [ruby-dev-builder](https://github.com/ruby/ruby-dev-builder), `jruby-head` is generated by [jruby-dev-builder](https://github.com/ruby/jruby-dev-builder), `truffleruby-head` is generated by [truffleruby-dev-builder](https://github.com/ruby/truffleruby-dev-builder)