Automatically pick the latest version of 2.6 for testing

* 2.6.7 is not yet available on Windows

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,10 +10,11 @@ assignees: ''
 <!--
 Before filing this issue:
 * If the issue happens on JRuby or TruffleRuby, and does not happen on CRuby (please check), file an issue there instead. It's very unlikely ruby/setup-ruby is the cause.
-* Try to reproduce the issue locally by following the workflow steps (including all all commands done by ruby/setup-ruby, except for `Downloading Ruby` & `Extracting Ruby`). If it does reproduce locally, it's not a ruby/setup-ruby issue.
+* Try to reproduce the issue locally by following the workflow steps (including all commands done by ruby/setup-ruby, except for `Downloading Ruby` & `Extracting Ruby`). If it does reproduce locally, it's not a ruby/setup-ruby issue.
 
 Please provide:
 * the code of or a link to the workflow used
 * the link to the log of a failed workflow job
 * the command and output of the step failing
+* whether you are using a self-hosted runner
 -->

.github/workflows/test.yml

@@ -16,8 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu-18.04, ubuntu-20.04, macos-10.15, macos-11.0, windows-2016, windows-2019 ]
-        # Use various version syntax here for testing
+        ruby: [ 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, '3.0', ruby-head, jruby, jruby-head, truffleruby, truffleruby-head ]
-        ruby: [ 2.1, 2.2, 2.3, 2.4, 2.5, 2.6.6, 2.7, '3.0', ruby-head, jruby, jruby-head, truffleruby, truffleruby-head ]
         include:
         - { os: windows-2016, ruby: mingw }
         - { os: windows-2019, ruby: mingw }
@@ -29,7 +28,6 @@ jobs:
         - { os: windows-2019, ruby: debug }
         - { os: windows-2019, ruby: truffleruby }
         - { os: windows-2019, ruby: truffleruby-head }
-        - { os: macos-11.0, ruby: truffleruby }
 
     name: ${{ matrix.os }} ${{ matrix.ruby }}
     runs-on: ${{ matrix.os }}
@@ -96,9 +94,10 @@ jobs:
     - name: bash test
       shell: bash
       run: echo ~
-    - name: Windows JRuby
+    # Disabled until https://github.com/jruby/jruby/issues/6648 is fixed
-      if: startsWith(matrix.os, 'windows') && startsWith(matrix.ruby, 'jruby')
+    # - name: Windows JRuby
-      run: gem install sassc -N
+    #   if: startsWith(matrix.os, 'windows') && startsWith(matrix.ruby, 'jruby')
+    #   run: gem install sassc -N
 
   testExactBundlerVersion:
     name: "Test with an exact Bundler version"

README.md

@@ -14,9 +14,9 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
 
 | Interpreter | Versions |
 | ----------- | -------- |
-| `ruby` | 2.1.9, 2.2, 2.3.0 - 2.3.8, 2.4.0 - 2.4.10, 2.5.0 - 2.5.8, 2.6.0 - 2.6.6, 2.7.2, 3.0.0, head, debug, mingw, mswin |
+| `ruby` | 2.1.9, 2.2, all versions from 2.3.0 until 3.0.1, head, debug, mingw, mswin |
-| `jruby` | 9.1.17.0, 9.2.9.0 - 9.2.13.0, head |
+| `jruby` | 9.1.17.0, 9.2.9.0 - 9.2.17.0, head |
-| `truffleruby` | 19.3.0 - 20.3.0, head |
+| `truffleruby` | 19.3.0 - 21.0.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.
@@ -38,7 +38,7 @@ The action works for all [GitHub-hosted runners](https://help.github.com/en/acti
 
 | Operating System | Recommended | Other Supported Versions |
 | ----------- | -------- | -------- |
-| Ubuntu  | `ubuntu-latest`  (= `ubuntu-18.04`) | `ubuntu-20.04`, `ubuntu-16.04` |
+| Ubuntu  | `ubuntu-latest`  (= `ubuntu-20.04`) | `ubuntu-18.04`, `ubuntu-16.04` |
 | macOS   | `macos-latest`   (= `macos-10.15`)  | `macos-11.0` |
 | Windows | `windows-latest` (= `windows-2019`) | `windows-2016` |
 
@@ -83,6 +83,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
         ruby: [2.5, 2.6, 2.7, '3.0', head, jruby, jruby-head, truffleruby, truffleruby-head]
     runs-on: ${{ matrix.os }}
     steps:
@@ -110,7 +111,7 @@ jobs:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
     steps:
       - uses: actions/checkout@v2
-      - uses: ./
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
@@ -162,13 +163,23 @@ If there is a `Gemfile.lock` (or `$BUNDLE_GEMFILE.lock` or `gems.locked`), `bund
 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
 as shown in the [example](#matrix-of-gemfiles).
 
-When there is no lockfile, one is generated with `bundle lock`, which is the same as `bundle install` would do first before actually fetching any gem.
+#### bundle config
-In other words, it works exactly like `bundle install`.
+
-The hash of the generated lockfile is then used for caching, which is the only correct approach.
+When using `bundler-cache: true` you might notice there is no good place to run `bundle config ...` commands.
+These can be replaced by `BUNDLE_*` environment variables, which are also faster.
+They should be set in the `env` at the job level as shown in the [example](#matrix-of-gemfiles).
+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`.  
 Therefore, the Bundler `path` should not be changed in your workflow for the cache to work (no `bundle config path`).
 
+#### How it Works
+
+When there is no lockfile, one is generated with `bundle lock`, which is the same as `bundle install` would do first before actually fetching any gem.
+In other words, it works exactly like `bundle install`.
+The hash of the generated lockfile is then used for caching, which is the only correct approach.
+
 #### Caching `bundle install` manually
 
 It is also possible to cache gems manually, but this is not recommended because it is verbose and *very difficult* to do correctly.
@@ -205,7 +216,7 @@ This action might work with [self-hosted runners](https://docs.github.com/en/act
 if the [virtual environment](https://github.com/actions/virtual-environments) is very similar to the ones used by GitHub runners. Notably:
 
 * Make sure to use the same operating system and version.
-* Set the environment variable `ImageOS` to the corresponding value on GitHub-hosted runners (e.g. `ubuntu18`/`macos1015`/`win19`). This is necessary to detect the operating system and version.
+* Set the environment variable `ImageOS` on the runner to the corresponding value on GitHub-hosted runners (e.g. `ubuntu18`/`macos1015`/`win19`). This is necessary to detect the operating system and version.
 * Make sure to use the same version of libssl.
 * Make sure that the operating system has `libyaml-0` installed
 * The default tool cache directory (`/opt/hostedtoolcache` on Linux, `/Users/runner/hostedtoolcache` on macOS,

bundler.js

@@ -72,8 +72,8 @@ export async function installBundler(bundlerVersionInput, lockFile, platform, ru
   if (engine === 'ruby' && rubyVersion.match(/^2\.[012]/)) {
     console.log('Bundler 2 requires Ruby 2.3+, using Bundler 1 on Ruby <= 2.2')
     bundlerVersion = '1'
-  } else if (engine === 'ruby' && rubyVersion.startsWith('2.3')) {
+  } else if (engine === 'ruby' && rubyVersion.match(/^2\.3\.[01]/)) {
-    console.log('Ruby 2.3 has a bug with Bundler 2 (https://github.com/rubygems/rubygems/issues/3570), using Bundler 1 instead on Ruby 2.3')
+    console.log('Ruby 2.3.0 and 2.3.1 have shipped with an old rubygems that only works with Bundler 1')
     bundlerVersion = '1'
   } else if (engine === 'jruby' && rubyVersion.startsWith('9.1')) { // JRuby 9.1 targets Ruby 2.3, treat it the same
     console.log('JRuby 9.1 has a bug with Bundler 2 (https://github.com/ruby/setup-ruby/issues/108), using Bundler 1 instead on JRuby 9.1')
@@ -81,6 +81,8 @@ export async function installBundler(bundlerVersionInput, lockFile, platform, ru
   }
 
   if (common.isHeadVersion(rubyVersion) && common.isBundler2Default(engine, rubyVersion) && bundlerVersion.startsWith('2')) {
+    // Avoid installing a newer Bundler version for head versions as it might not work.
+    // For releases, even if they ship with Bundler 2 we install the latest Bundler.
     console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
   } else if (engine === 'truffleruby' && !common.isHeadVersion(rubyVersion) && bundlerVersion.startsWith('1')) {
     console.log(`Using Bundler 1 shipped with ${engine}`)

common.js

@@ -59,7 +59,9 @@ export function isBundler2Default(engine, rubyVersion) {
   if (engine === 'ruby') {
     return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 2.7
   } else if (engine === 'truffleruby') {
-    return isHeadVersion(rubyVersion)
+    return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 21.0
+  } else if (engine === 'jruby') {
+    return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 9.3
   } else {
     return false
   }

dist/index.js

@@ -32851,7 +32851,9 @@ function isBundler2Default(engine, rubyVersion) {
   if (engine === 'ruby') {
     return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 2.7
   } else if (engine === 'truffleruby') {
-    return isHeadVersion(rubyVersion)
+    return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 21.0
+  } else if (engine === 'jruby') {
+    return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 9.3
   } else {
     return false
   }
@@ -44608,8 +44610,8 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
   if (engine === 'ruby' && rubyVersion.match(/^2\.[012]/)) {
     console.log('Bundler 2 requires Ruby 2.3+, using Bundler 1 on Ruby <= 2.2')
     bundlerVersion = '1'
-  } else if (engine === 'ruby' && rubyVersion.startsWith('2.3')) {
+  } else if (engine === 'ruby' && rubyVersion.match(/^2\.3\.[01]/)) {
-    console.log('Ruby 2.3 has a bug with Bundler 2 (https://github.com/rubygems/rubygems/issues/3570), using Bundler 1 instead on Ruby 2.3')
+    console.log('Ruby 2.3.0 and 2.3.1 have shipped with an old rubygems that only works with Bundler 1')
     bundlerVersion = '1'
   } else if (engine === 'jruby' && rubyVersion.startsWith('9.1')) { // JRuby 9.1 targets Ruby 2.3, treat it the same
     console.log('JRuby 9.1 has a bug with Bundler 2 (https://github.com/ruby/setup-ruby/issues/108), using Bundler 1 instead on JRuby 9.1')
@@ -44617,6 +44619,8 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
   }
 
   if (common.isHeadVersion(rubyVersion) && common.isBundler2Default(engine, rubyVersion) && bundlerVersion.startsWith('2')) {
+    // Avoid installing a newer Bundler version for head versions as it might not work.
+    // For releases, even if they ship with Bundler 2 we install the latest Bundler.
     console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
   } else if (engine === 'truffleruby' && !common.isHeadVersion(rubyVersion) && bundlerVersion.startsWith('1')) {
     console.log(`Using Bundler 1 shipped with ${engine}`)
@@ -45346,20 +45350,21 @@ function getVersions(platform) {
       "2.2.10",
       "2.3.0", "2.3.1", "2.3.2", "2.3.3", "2.3.4", "2.3.5", "2.3.6", "2.3.7", "2.3.8",
       "2.4.0", "2.4.1", "2.4.2", "2.4.3", "2.4.4", "2.4.5", "2.4.6", "2.4.7", "2.4.9", "2.4.10",
-      "2.5.0", "2.5.1", "2.5.2", "2.5.3", "2.5.4", "2.5.5", "2.5.6", "2.5.7", "2.5.8",
+      "2.5.0", "2.5.1", "2.5.2", "2.5.3", "2.5.4", "2.5.5", "2.5.6", "2.5.7", "2.5.8", "2.5.9",
-      "2.6.0", "2.6.1", "2.6.2", "2.6.3", "2.6.4", "2.6.5", "2.6.6",
+      "2.6.0", "2.6.1", "2.6.2", "2.6.3", "2.6.4", "2.6.5", "2.6.6", "2.6.7",
-      "2.7.0", "2.7.1", "2.7.2",
+      "2.7.0", "2.7.1", "2.7.2", "2.7.3",
-      "3.0.0-preview1", "3.0.0-preview2", "3.0.0-rc1", "3.0.0",
+      "3.0.0-preview1", "3.0.0-preview2", "3.0.0-rc1", "3.0.0", "3.0.1",
       "head", "debug",
     ],
     "jruby": [
       "9.1.17.0",
-      "9.2.9.0", "9.2.10.0", "9.2.11.0", "9.2.11.1", "9.2.12.0", "9.2.13.0", "9.2.14.0",
+      "9.2.9.0", "9.2.10.0", "9.2.11.0", "9.2.11.1", "9.2.12.0", "9.2.13.0", "9.2.14.0", "9.2.15.0", "9.2.16.0", "9.2.17.0",
       "head"
     ],
     "truffleruby": [
       "19.3.0", "19.3.1",
       "20.0.0", "20.1.0", "20.2.0", "20.3.0",
+      "21.0.0",
       "head"
     ]
   }
@@ -52088,7 +52093,7 @@ async function setupRuby(options = {}) {
   const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
 
   let installer
-  if (platform.startsWith('windows-') && engine === 'ruby') {
+  if (platform.startsWith('windows-') && engine !== 'jruby') {
     installer = __webpack_require__(216)
   } else {
     installer = __webpack_require__(974)

index.js

@@ -38,7 +38,7 @@ export async function setupRuby(options = {}) {
   const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
 
   let installer
-  if (platform.startsWith('windows-') && engine === 'ruby') {
+  if (platform.startsWith('windows-') && engine !== 'jruby') {
     installer = require('./windows')
   } else {
     installer = require('./ruby-builder')

pre-commit

@@ -1,4 +1,5 @@
 #!/usr/bin/sh
 set -e
+yarn install
 yarn run package
 exec git add dist/index.js

ruby-builder-versions.js

@@ -5,20 +5,21 @@ export function getVersions(platform) {
       "2.2.10",
       "2.3.0", "2.3.1", "2.3.2", "2.3.3", "2.3.4", "2.3.5", "2.3.6", "2.3.7", "2.3.8",
       "2.4.0", "2.4.1", "2.4.2", "2.4.3", "2.4.4", "2.4.5", "2.4.6", "2.4.7", "2.4.9", "2.4.10",
-      "2.5.0", "2.5.1", "2.5.2", "2.5.3", "2.5.4", "2.5.5", "2.5.6", "2.5.7", "2.5.8",
+      "2.5.0", "2.5.1", "2.5.2", "2.5.3", "2.5.4", "2.5.5", "2.5.6", "2.5.7", "2.5.8", "2.5.9",
-      "2.6.0", "2.6.1", "2.6.2", "2.6.3", "2.6.4", "2.6.5", "2.6.6",
+      "2.6.0", "2.6.1", "2.6.2", "2.6.3", "2.6.4", "2.6.5", "2.6.6", "2.6.7",
-      "2.7.0", "2.7.1", "2.7.2",
+      "2.7.0", "2.7.1", "2.7.2", "2.7.3",
-      "3.0.0-preview1", "3.0.0-preview2", "3.0.0-rc1", "3.0.0",
+      "3.0.0-preview1", "3.0.0-preview2", "3.0.0-rc1", "3.0.0", "3.0.1",
       "head", "debug",
     ],
     "jruby": [
       "9.1.17.0",
-      "9.2.9.0", "9.2.10.0", "9.2.11.0", "9.2.11.1", "9.2.12.0", "9.2.13.0", "9.2.14.0",
+      "9.2.9.0", "9.2.10.0", "9.2.11.0", "9.2.11.1", "9.2.12.0", "9.2.13.0", "9.2.14.0", "9.2.15.0", "9.2.16.0", "9.2.17.0",
       "head"
     ],
     "truffleruby": [
       "19.3.0", "19.3.1",
       "20.0.0", "20.1.0", "20.2.0", "20.3.0",
+      "21.0.0",
       "head"
     ]
   }