Enable sassc test on JRuby on Windows

9.2.18.0 has been released, so this should work now.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!--
+Before filing this issue:
+* Make sure you use the latest version with `- uses: ruby/setup-ruby@v1` (see https://github.com/ruby/setup-ruby/blob/master/README.md#versioning)
+* 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 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

@@ -15,11 +15,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-16.04, ubuntu-18.04, ubuntu-20.04, macos-10.15, windows-2016, windows-2019 ]
+        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.0', 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, ruby-head, debug, jruby-9.1, jruby, jruby-head, truffleruby, truffleruby-head ]
         include:
-        - { os: ubuntu-18.04, ruby: rubinius }
         - { os: windows-2016, ruby: mingw }
         - { os: windows-2019, ruby: mingw }
         - { os: windows-2019, ruby: mswin }
@@ -60,6 +58,10 @@ jobs:
             echo 'ridk is unavailable'
           }
         }
+    - name: RbConfig::CONFIG
+      run: ruby -rrbconfig -rpp -e 'pp RbConfig::CONFIG'
+    - name: RbConfig::MAKEFILE_CONFIG
+      run: ruby -rrbconfig -rpp -e 'pp RbConfig::MAKEFILE_CONFIG'
 
     - name: Subprocess test
       run: ruby test_subprocess.rb
@@ -68,9 +70,11 @@ jobs:
     - name: OpenSSL test
       run: ruby -ropen-uri -e 'puts URI.send(:open, %{https://rubygems.org/}) { |f| f.read(1024) }'
 
+    - run: gem env
     - name: C extension test
       run: gem install json:2.2.0 --no-document
     - run: bundle --version
+    # This step is redundant with `bundler-cache: true` but is there to check a redundant `bundle install` still works
     - run: bundle install
     - run: bundle exec rake --version
 
@@ -93,10 +97,65 @@ jobs:
       run: echo ~
     - name: Windows JRuby
       if: startsWith(matrix.os, 'windows') && startsWith(matrix.ruby, 'jruby')
-      run: gem install sassc -N
+      run: gem install sassc
+
+  testExactBundlerVersion:
+    name: "Test with an exact Bundler version"
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ./
+      with:
+        ruby-version: 2.6
+        bundler: 2.2.3
+    - run: bundle --version | grep -F "Bundler version 2.2.3"
+
+  testDependencyOnBundler1:
+    name: "Test gemfile depending on Bundler 1"
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: gemfiles/bundler1.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+        with:
+          ruby-version: 2.7
+          bundler: 1
+          bundler-cache: true
+      - run: bundle --version | grep -F "Bundler version 1."
+
+  testGemfileMatrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile: [ rails5, rails6 ]
+    name: "Test with ${{ matrix.gemfile }} gemfile"
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+        with:
+          ruby-version: 2.6
+          bundler-cache: true
+      - run: bundle exec rails --version
+
+  testTruffleRubyNokogiri:
+    name: "Test installing a Gemfile with nokogiri on TruffleRuby"
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: gemfiles/nokogiri.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+        with:
+          ruby-version: truffleruby-head
+          bundler-cache: true
+      - run: bundle list | grep nokogiri
 
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
     - uses: actions/checkout@v2
     - run: yarn install

README.md

@@ -14,33 +14,34 @@ 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.1, head, debug, mingw, mswin |
+| `ruby` | 2.0.0, 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.18.0, head |
-| TruffleRuby | 19.3.0 - 20.2.0, head |
+| `truffleruby` | 19.3.0 - 21.1.0, head |
-| Rubinius | 4.14 |
 
 `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.
 
-Ruby 2.2 resolves to 2.2.6 on Windows (last build from RubyInstaller) and 2.2.10 otherwise.  
+Preview and RC versions of Ruby might be available too on Ubuntu and macOS (not on Windows).
-Ruby 2.3 on Windows only has builds for 2.3.0, 2.3.1 and 2.3.3 (same as RubyInstaller).
+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.
 
-Note that Ruby ≤ 2.3 and the OpenSSL version it needs (1.0.2) are both end-of-life,
+Only versions published by [RubyInstaller](https://rubyinstaller.org/downloads/archives/) are available on Windows.
-which means Ruby ≤ 2.3 is unmaintained and considered insecure.
+Due to that, Ruby 2.2 resolves to 2.2.6 on Windows and 2.2.10 on other platforms.
-On Windows, Ruby 2.4 uses OpenSSL 1.0.2, which is no longer maintained.
+And 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.
 
 ### Supported Platforms
 
-The action works for all [GitHub-hosted runners](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners), and [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners), under [certain conditions](#limitations)
+The action works for all [GitHub-hosted runners](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners).
 
 | 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   | `macos-latest`   (= `macos-10.15`)  | `macos-11.0` |
 | Windows | `windows-latest` (= `windows-2019`) | `windows-2016` |
 
-Rubinius is only available on `ubuntu-18.04`.
-
 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).
@@ -56,7 +57,7 @@ for Ubuntu and macOS and in [windows-versions.js](windows-versions.js) for Windo
 
 ```yaml
 name: My workflow
-on: [push]
+on: [push, pull_request]
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -65,35 +66,58 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.6 # Not needed with a .ruby-version file
-    - run: bundle install
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - run: bundle exec rake
 ```
 
-### Matrix
+### Matrix of Ruby Versions
 
 This matrix tests all stable releases and `head` versions of MRI, JRuby and TruffleRuby on Ubuntu and macOS.
 
 ```yaml
 name: My workflow
-on: [push]
+on: [push, pull_request]
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu, macos]
+        os: [ubuntu-latest, macos-latest]
-        ruby: [2.5, 2.6, 2.7, head, debug, jruby, jruby-head, truffleruby, truffleruby-head]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-    runs-on: ${{ matrix.os }}-latest
+        ruby: [2.5, 2.6, 2.7, '3.0', head, jruby, jruby-head, truffleruby, truffleruby-head]
-    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - run: bundle install
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - run: bundle exec rake
 ```
 
+### Matrix of Gemfiles
+
+```yaml
+name: My workflow
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile: [ rails5, rails6 ]
+    runs-on: ubuntu-latest
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake
+```
+
 See the GitHub Actions documentation for more details about the
 [workflow syntax](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions)
 and the [condition and expression syntax](https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions).
@@ -115,11 +139,11 @@ if they are not at the root of the repository, see [action.yml](action.yml) for
 
 ### Bundler
 
-By default, if there is a `Gemfile.lock` file (or `$BUNDLE_GEMFILE.lock` if `$BUNDLE_GEMFILE` is set) with a `BUNDLED WITH` section,
+By default, if there is a `Gemfile.lock` file (or `$BUNDLE_GEMFILE.lock` or `gems.locked`) with a `BUNDLED WITH` section,
-the latest version of Bundler with the same major version will be installed.
+that version of Bundler will be installed and used.
 Otherwise, the latest compatible Bundler version is installed (Bundler 2 on Ruby >= 2.4, Bundler 1 on Ruby < 2.4).
 
-This behavior can be customized, see [action.yml](action.yml) for details about the `bundler` input.
+This behavior can be customized, see [action.yml](action.yml) for more details about the `bundler` input.
 
 ### Caching `bundle install` automatically
 
@@ -130,42 +154,51 @@ This action provides a way to automatically run `bundle install` and cache the r
         bundler-cache: true
 ```
 
+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`) under the [`working-directory`](#working-directory).  
+It needs a `Gemfile` (or `$BUNDLE_GEMFILE` or `gems.rb`) under the [`working-directory`](#working-directory).  
-The caching works whether there is a `Gemfile.lock` or not.
+If there is a `Gemfile.lock` (or `$BUNDLE_GEMFILE.lock` or `gems.locked`), `bundle config --local deployment true` is used.
-If there is a `Gemfile.lock`, `bundle config --local deployment true` is used.
 
-To perform caching, this action will use `bundle config --local path vendor/bundle`.  
+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
-Therefore, the Bundler `path` should not be changed in your workflow for the cache to work.
+as shown in the [example](#matrix-of-gemfiles).
 
-### Caching `bundle install` manually
+#### bundle config
 
-You can also cache gems manually,
+When using `bundler-cache: true` you might notice there is no good place to run `bundle config ...` commands.
-but this is not recommended because it is verbose and very difficult to use a correct cache key.
+These can be replaced by `BUNDLE_*` environment variables, which are also faster.
-You can cache the installed gems with these two steps:
+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.
+
+#### Dealing with a corrupted cache
+
+In some rare scenarios (like using gems with C extensions whose functionality depends on libraries found on the system
+at the time of the gem's build) it may be necessary to ignore contents of the cache and get and build all the gems anew.
+In order to achieve this, set the `cache-version` option to any value other than `0` (or change it to a new unique value
+if you have already used it before.)
 
 ```yaml
-    - uses: actions/cache@v2
+    - uses: ruby/setup-ruby@v1
       with:
-        path: vendor/bundle
+        bundler-cache: true
-        key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
+        cache-version: 1
-        restore-keys: |
-          bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-
-    - name: bundle install
-      run: |
-        bundle config deployment true
-        bundle config path vendor/bundle
-        bundle install --jobs 4
 ```
 
-When using a single OS, replace `${{ matrix.os }}` with the OS.  
+#### Caching `bundle install` manually
-When using a single job with a Ruby version, replace `${{ matrix.ruby }}` with the Ruby version.  
-When using `.ruby-version`, replace `${{ matrix.ruby }}` with `${{ hashFiles('.ruby-version') }}`.  
-When using `.tool-versions`, replace `${{ matrix.ruby }}` with `${{ hashFiles('.tool-versions') }}`.
 
-This uses the [cache action](https://github.com/actions/cache).
+It is also possible to cache gems manually, but this is not recommended because it is verbose and *very difficult* to do correctly.
-The code above is a more complete version of the [Ruby - Bundler example](https://github.com/actions/cache/blob/master/examples.md#ruby---bundler).
+There are many concerns which means using `actions/cache` is never enough for caching gems (e.g., incomplete cache key, cleaning old gems when restoring from another key, correctly hashing the lockfile if not checked in, OS versions, ABI compatibility for `ruby-head`, etc).
-Make sure to include `use-ruby` in the `key` to avoid conflicting with previous caches.
+So, please use `bundler-cache: true` instead and report any issue.
 
 ## Windows
 
@@ -192,10 +225,20 @@ This action follows semantic versioning with a moving `v1` branch.
 This follows the [recommendations](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) of GitHub Actions.
 
 ## Using self-hosted runners
-You must meet the following parameters to use this action with self-hosted runners:
 
+This action might work with [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners)
+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` 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 runner software is running as user `runner` with a home directory of `/home/runner`, or you have created a symlink for the home directory of whatever user that the runner is running as to `/home/runner`.
+* The default tool cache directory (`/opt/hostedtoolcache` on Linux, `/Users/runner/hostedtoolcache` on macOS,
+  `C:/hostedtoolcache/windows` on Windows) must be writable by the `runner` user.
+  This is necessary since the Ruby builds embed the install path when built and cannot be moved around.
+* `/home/runner` must be writable by the `runner` user.
+
+In other cases, please use a system Ruby or [install Ruby manually](https://github.com/postmodern/chruby/wiki#installing-rubies) instead.
 
 ## History
 

action.yml

@@ -11,9 +11,9 @@ inputs:
     default: 'default'
   bundler:
     description: |
-      The version of Bundler to install. Either 'none', 1, 2, 'latest' or 'Gemfile.lock'.
+      The version of Bundler to install. Either 'none', 'latest', 'Gemfile.lock', or a version number (e.g., 1, 2, 2.1.4).
-      For 'Gemfile.lock', the version is determined based on the BUNDLED WITH section from the file ($BUNDLE_GEMFILE || Gemfile).lock.
+      For 'Gemfile.lock', the version is determined based on the BUNDLED WITH section from the file Gemfile.lock, $BUNDLE_GEMFILE.lock or gems.locked.
-      Defaults to 'Gemfile.lock' if it exists and 'latest' otherwise.
+      Defaults to 'Gemfile.lock' if the file exists and 'latest' otherwise.
     required: false
     default: 'default'
   bundler-cache:
@@ -24,6 +24,12 @@ inputs:
     description: 'The working directory to use for resolving paths for .ruby-version, .tool-versions and Gemfile.lock.'
     required: false
     default: '.'
+  cache-version:
+    description: |
+      Arbitrary string that will be added to the cache key of the bundler cache. Set or change it if you need
+      to invalidate the cache.
+    required: false
+    default: '0'
 outputs:
   ruby-prefix:
     description: 'The prefix of the installed ruby'

bundler.js

@@ -0,0 +1,201 @@
+const fs = require('fs')
+const path = require('path')
+const core = require('@actions/core')
+const exec = require('@actions/exec')
+const cache = require('@actions/cache')
+const common = require('./common')
+
+export const DEFAULT_CACHE_VERSION = '0'
+
+// The returned gemfile is guaranteed to exist, the lockfile might not exist
+export function detectGemfiles() {
+  const gemfilePath = process.env['BUNDLE_GEMFILE'] || 'Gemfile'
+  if (fs.existsSync(gemfilePath)) {
+    return [gemfilePath, `${gemfilePath}.lock`]
+  } else if (process.env['BUNDLE_GEMFILE']) {
+    throw new Error(`$BUNDLE_GEMFILE is set to ${gemfilePath} but does not exist`)
+  }
+
+  if (fs.existsSync("gems.rb")) {
+    return ["gems.rb", "gems.locked"]
+  }
+
+  return [null, null]
+}
+
+function readBundledWithFromGemfileLock(lockFile) {
+  if (lockFile !== null && fs.existsSync(lockFile)) {
+    const contents = fs.readFileSync(lockFile, 'utf8')
+    const lines = contents.split(/\r?\n/)
+    const bundledWithLine = lines.findIndex(line => /^BUNDLED WITH$/.test(line.trim()))
+    if (bundledWithLine !== -1) {
+      const nextLine = lines[bundledWithLine+1]
+      if (nextLine && /^\d+/.test(nextLine.trim())) {
+        const bundlerVersion = nextLine.trim()
+        console.log(`Using Bundler ${bundlerVersion} from ${lockFile} BUNDLED WITH ${bundlerVersion}`)
+        return bundlerVersion
+      }
+    }
+  }
+  return null
+}
+
+async function afterLockFile(lockFile, platform, engine) {
+  if (engine === 'truffleruby' && platform.startsWith('ubuntu-')) {
+    const contents = fs.readFileSync(lockFile, 'utf8')
+    if (contents.includes('nokogiri')) {
+      await common.measure('Installing libxml2-dev libxslt-dev, required to install nokogiri on TruffleRuby', async () =>
+          exec.exec('sudo', ['apt-get', '-yqq', 'install', 'libxml2-dev', 'libxslt-dev'], { silent: true }))
+    }
+  }
+}
+
+export async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefix, engine, rubyVersion) {
+  let bundlerVersion = bundlerVersionInput
+
+  if (bundlerVersion === 'default' || bundlerVersion === 'Gemfile.lock') {
+    bundlerVersion = readBundledWithFromGemfileLock(lockFile)
+
+    if (!bundlerVersion) {
+      bundlerVersion = 'latest'
+    }
+  }
+
+  if (bundlerVersion === 'latest') {
+    bundlerVersion = '2'
+  }
+
+  if (/^\d+/.test(bundlerVersion)) {
+    // OK
+  } else {
+    throw new Error(`Cannot parse bundler input: ${bundlerVersion}`)
+  }
+
+  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.match(/^2\.3\.[01]/)) {
+    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')
+    bundlerVersion = '1'
+  }
+
+  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}`)
+  } else {
+    const gem = path.join(rubyPrefix, 'bin', 'gem')
+    const bundlerVersionConstraint = bundlerVersion.match(/^\d+\.\d+\.\d+/) ? bundlerVersion : `~> ${bundlerVersion}`
+    await exec.exec(gem, ['install', 'bundler', '-v', bundlerVersionConstraint, '--no-document'])
+  }
+
+  return bundlerVersion
+}
+
+export async function bundleInstall(gemfile, lockFile, platform, engine, rubyVersion, bundlerVersion, cacheVersion) {
+  if (gemfile === null) {
+    console.log('Could not determine gemfile path, skipping "bundle install" and caching')
+    return false
+  }
+
+  let envOptions = {}
+  if (bundlerVersion.startsWith('1') && common.isBundler2Default(engine, rubyVersion)) {
+    // If Bundler 1 is specified on Rubies which ship with Bundler 2,
+    // we need to specify which Bundler version to use explicitly until the lockfile exists.
+    console.log(`Setting BUNDLER_VERSION=${bundlerVersion} for "bundle config|lock" commands below to ensure Bundler 1 is used`)
+    envOptions = { env: { ...process.env, BUNDLER_VERSION: bundlerVersion } }
+  }
+
+  // config
+  const cachePath = 'vendor/bundle'
+  // An absolute path, so it is reliably under $PWD/vendor/bundle, and not relative to the gemfile's directory
+  const bundleCachePath = path.join(process.cwd(), cachePath)
+
+  await exec.exec('bundle', ['config', '--local', 'path', bundleCachePath], envOptions)
+
+  if (fs.existsSync(lockFile)) {
+    await exec.exec('bundle', ['config', '--local', 'deployment', 'true'], envOptions)
+  } else {
+    // Generate the lockfile so we can use it to compute the cache key.
+    // This will also automatically pick up the latest gem versions compatible with the Gemfile.
+    await exec.exec('bundle', ['lock'], envOptions)
+  }
+
+  await afterLockFile(lockFile, platform, engine)
+
+  // cache key
+  const paths = [cachePath]
+  const baseKey = await computeBaseKey(platform, engine, rubyVersion, lockFile, cacheVersion)
+  const key = `${baseKey}-${await common.hashFile(lockFile)}`
+  // If only Gemfile.lock changes we can reuse part of the cache, and clean old gem versions below
+  const restoreKeys = [`${baseKey}-`]
+  console.log(`Cache key: ${key}`)
+
+  // restore cache & install
+  let cachedKey = null
+  try {
+    cachedKey = await cache.restoreCache(paths, key, restoreKeys)
+  } catch (error) {
+    if (error.name === cache.ValidationError.name) {
+      throw error;
+    } else {
+      core.info(`[warning] There was an error restoring the cache ${error.message}`)
+    }
+  }
+
+  if (cachedKey) {
+    console.log(`Found cache for key: ${cachedKey}`)
+  }
+
+  // Always run 'bundle install' to list the gems
+  await exec.exec('bundle', ['install', '--jobs', '4'])
+
+  // @actions/cache only allows to save for non-existing keys
+  if (cachedKey !== key) {
+    if (cachedKey) { // existing cache but Gemfile.lock differs, clean old gems
+      await exec.exec('bundle', ['clean'])
+    }
+
+    // Error handling from https://github.com/actions/cache/blob/master/src/save.ts
+    console.log('Saving cache')
+    try {
+      await cache.saveCache(paths, key)
+    } catch (error) {
+      if (error.name === cache.ValidationError.name) {
+        throw error;
+      } else if (error.name === cache.ReserveCacheError.name) {
+        core.info(error.message);
+      } else {
+        core.info(`[warning]${error.message}`)
+      }
+    }
+  }
+
+  return true
+}
+
+async function computeBaseKey(platform, engine, version, lockFile, cacheVersion) {
+  const cacheVersionSuffix = DEFAULT_CACHE_VERSION === cacheVersion ? '' : `-cachever:${cacheVersion}`
+  let key = `setup-ruby-bundler-cache-v3-${platform}-${engine}-${version}${cacheVersionSuffix}`
+
+  if (engine !== 'jruby' && common.isHeadVersion(version)) {
+    let revision = '';
+    await exec.exec('ruby', ['-e', 'print RUBY_REVISION'], {
+      silent: true,
+      listeners: {
+        stdout: (data) => {
+          revision += data.toString();
+        }
+      }
+    });
+    key += `-revision-${revision}`
+  }
+
+  key += `-${lockFile}`
+  return key
+}

common.js

@@ -11,8 +11,18 @@ export const windows = (os.platform() === 'win32')
 // Extract to SSD on Windows, see https://github.com/ruby/setup-ruby/pull/14
 export const drive = (windows ? (process.env['GITHUB_WORKSPACE'] || 'C')[0] : undefined)
 
+export function partition(string, separator) {
+  const i = string.indexOf(separator)
+  if (i === -1) {
+    throw new Error(`No separator ${separator} in string ${string}`)
+  }
+  return [string.slice(0, i), string.slice(i + separator.length, string.length)]
+}
+
+let inGroup = false
+
 export async function measure(name, block) {
-  return await core.group(name, async () => {
+  const body = async () => {
     const start = performance.now()
     try {
       return await block()
@@ -21,13 +31,51 @@ export async function measure(name, block) {
       const duration = (end - start) / 1000.0
       console.log(`Took ${duration.toFixed(2).padStart(6)} seconds`)
     }
-  })
+  }
+
+  if (inGroup) {
+    // Nested groups are not yet supported on GitHub Actions
+    console.log(`> ${name}`)
+    return await body()
+  } else {
+    inGroup = true
+    try {
+      return await core.group(name, body)
+    } finally {
+      inGroup = false
+    }
+  }
 }
 
 export function isHeadVersion(rubyVersion) {
   return rubyVersion === 'head' || rubyVersion === 'debug' || rubyVersion === 'mingw' || rubyVersion === 'mswin'
 }
 
+export function isStableVersion(rubyVersion) {
+  return /^\d+(\.\d+)*$/.test(rubyVersion)
+}
+
+export function isBundler2Default(engine, rubyVersion) {
+  if (engine === 'ruby') {
+    return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 2.7
+  } else if (engine === 'truffleruby') {
+    return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 21.0
+  } else if (engine === 'jruby') {
+    return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 9.3
+  } else {
+    return false
+  }
+}
+
+export function floatVersion(rubyVersion) {
+  const match = rubyVersion.match(/^\d+\.\d+/)
+  if (match) {
+    return parseFloat(match[0])
+  } else {
+    return 0.0
+  }
+}
+
 export async function hashFile(file) {
   // See https://github.com/actions/runner/blob/master/src/Misc/expressionFunc/hashFiles/src/hashFiles.ts
   const hash = crypto.createHash('sha256')
@@ -36,34 +84,67 @@ export async function hashFile(file) {
   return hash.digest('hex')
 }
 
+function getImageOS() {
+  const imageOS = process.env['ImageOS']
+  if (!imageOS) {
+    throw new Error('The environment variable ImageOS must be set')
+  }
+  return imageOS
+}
+
 export function getVirtualEnvironmentName() {
-  const platform = os.platform()
+  const imageOS = getImageOS()
-  if (platform === 'linux') {
+
-    return `ubuntu-${findUbuntuVersion()}`
+  let match = imageOS.match(/^ubuntu(\d+)/) // e.g. ubuntu18
-  } else if (platform === 'darwin') {
+  if (match) {
-    return 'macos-latest'
+    return `ubuntu-${match[1]}.04`
-  } else if (platform === 'win32') {
+  }
-    return 'windows-latest'
+
+  match = imageOS.match(/^macos(\d{2})(\d+)?/) // e.g. macos1015, macos11
+  if (match) {
+    return `macos-${match[1]}.${match[2] || '0'}`
+  }
+
+  match = imageOS.match(/^win(\d+)/) // e.g. win19
+  if (match) {
+    return `windows-20${match[1]}`
+  }
+
+  throw new Error(`Unknown ImageOS ${imageOS}`)
+}
+
+export function shouldUseToolCache(engine, version) {
+  return engine === 'ruby' && !isHeadVersion(version)
+}
+
+function getPlatformToolCache(platform) {
+  // Hardcode paths rather than using $RUNNER_TOOL_CACHE because the prebuilt Rubies cannot be moved anyway
+  if (platform.startsWith('ubuntu-')) {
+    return '/opt/hostedtoolcache'
+  } else if (platform.startsWith('macos-')) {
+    return '/Users/runner/hostedtoolcache'
+  } else if (platform.startsWith('windows-')) {
+    return 'C:/hostedtoolcache/windows'
   } else {
-    throw new Error(`Unknown platform ${platform}`)
+    throw new Error('Unknown platform')
   }
 }
 
-function findUbuntuVersion() {
+export function getToolCacheRubyPrefix(platform, version) {
-  const lsb_release = fs.readFileSync('/etc/lsb-release', 'utf8')
+  const toolCache = getPlatformToolCache(platform)
-  const match = lsb_release.match(/^DISTRIB_RELEASE=(\d+\.\d+)$/m)
+  return path.join(toolCache, 'Ruby', version, 'x64')
-  if (match) {
+}
-    return match[1]
+
-  } else {
+export function createToolCacheCompleteFile(toolCacheRubyPrefix) {
-    throw new Error('Could not find Ubuntu version')
+  const completeFile = `${toolCacheRubyPrefix}.complete`
-  }
+  fs.writeFileSync(completeFile, '')
 }
 
 // convert windows path like C:\Users\runneradmin to /c/Users/runneradmin
 export function win2nix(path) {
   if (/^[A-Z]:/i.test(path)) {
     // path starts with drive
-    path = `/${path[0].toLowerCase()}${path.split(':', 2)[1]}`
+    path = `/${path[0].toLowerCase()}${partition(path, ':')[1]}`
   }
   return path.replace(/\\/g, '/').replace(/ /g, '\\ ')
 }

gemfiles/bundler1.gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem "bundler", "~> 1.0"

gemfiles/nokogiri.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "nokogiri"

gemfiles/rails5.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"

gemfiles/rails6.gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.0"

generate-windows-versions.rb

@@ -2,7 +2,7 @@ require 'net/http'
 require 'yaml'
 require 'json'
 
-min_requirements = ['~> 2.1.9', '>= 2.2.6'].map { |req| Gem::Requirement.new(req) }
+min_requirements = ['~> 2.0.0', '~> 2.1.9', '>= 2.2.6'].map { |req| Gem::Requirement.new(req) }
 
 url = 'https://raw.githubusercontent.com/oneclick/rubyinstaller.org-website/master/_data/downloads.yaml'
 entries = YAML.load(Net::HTTP.get(URI(url)), symbolize_names: true)
@@ -30,4 +30,4 @@ versions['mingw'] = 'https://github.com/MSP-Greg/ruby-loco/releases/download/rub
 versions['mswin'] = 'https://github.com/MSP-Greg/ruby-loco/releases/download/ruby-master/ruby-mswin.7z'
 
 js = "export const versions = #{JSON.pretty_generate(versions)}\n"
-File.write 'windows-versions.js', js
+File.binwrite 'windows-versions.js', js

index.js

@@ -2,9 +2,8 @@ const os = require('os')
 const fs = require('fs')
 const path = require('path')
 const core = require('@actions/core')
-const exec = require('@actions/exec')
-const cache = require('@actions/cache')
 const common = require('./common')
+const bundler = require('./bundler')
 
 const windows = common.windows
 
@@ -13,6 +12,7 @@ const inputDefaults = {
   'bundler': 'default',
   'bundler-cache': 'true',
   'working-directory': '.',
+  'cache-version': bundler.DEFAULT_CACHE_VERSION,
 }
 
 // entry point when this action is run on its own
@@ -39,7 +39,7 @@ export async function setupRuby(options = {}) {
   const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
 
   let installer
-  if (platform === 'windows-latest' && engine !== 'jruby') {
+  if (platform.startsWith('windows-') && engine !== 'jruby') {
     installer = require('./windows')
   } else {
     installer = require('./ruby-builder')
@@ -61,12 +61,14 @@ export async function setupRuby(options = {}) {
   }
 
   if (inputs['bundler'] !== 'none') {
-    await common.measure('Installing Bundler', async () =>
+    const [gemfile, lockFile] = bundler.detectGemfiles()
-      installBundler(inputs['bundler'], platform, rubyPrefix, engine, version))
+
+    const bundlerVersion = await common.measure('Installing Bundler', async () =>
+        bundler.installBundler(inputs['bundler'], lockFile, platform, rubyPrefix, engine, version))
 
     if (inputs['bundler-cache'] === 'true') {
       await common.measure('bundle install', async () =>
-          bundleInstall(platform, engine, version))
+          bundler.bundleInstall(gemfile, lockFile, platform, engine, version, bundlerVersion, inputs['cache-version']))
     }
   }
 
@@ -90,7 +92,7 @@ function parseRubyEngineAndVersion(rubyVersion) {
   } else if (rubyVersion === '.tool-versions') { // Read from .tool-versions
     const toolVersions = fs.readFileSync('.tool-versions', 'utf8').trim()
     const rubyLine = toolVersions.split(/\r?\n/).filter(e => e.match(/^ruby\s/))[0]
-    rubyVersion = rubyLine.split(/\s+/, 2)[1]
+    rubyVersion = rubyLine.match(/^ruby\s+(.+)$/)[1]
     console.log(`Using ${rubyVersion} as input from file .tool-versions`)
   }
 
@@ -100,9 +102,9 @@ function parseRubyEngineAndVersion(rubyVersion) {
     version = rubyVersion
   } else if (!rubyVersion.includes('-')) { // myruby -> myruby-stableVersion
     engine = rubyVersion
-    version = '' // Let the logic below find the version
+    version = '' // Let the logic in validateRubyEngineAndVersion() find the version
   } else { // engine-X.Y.Z
-    [engine, version] = rubyVersion.split('-', 2)
+    [engine, version] = common.partition(rubyVersion, '-')
   }
 
   return [engine, version]
@@ -116,12 +118,19 @@ function validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVe
   let version = parsedVersion
   if (!engineVersions.includes(parsedVersion)) {
     const latestToFirstVersion = engineVersions.slice().reverse()
-    const found = latestToFirstVersion.find(v => !common.isHeadVersion(v) && v.startsWith(parsedVersion))
+    // Try to match stable versions first, so an empty version (engine-only) matches the latest stable version
+    let found = latestToFirstVersion.find(v => common.isStableVersion(v) && v.startsWith(parsedVersion))
+    if (!found) {
+      // Exclude head versions, they must be exact matches
+      found = latestToFirstVersion.find(v => !common.isHeadVersion(v) && v.startsWith(parsedVersion))
+    }
+
     if (found) {
       version = found
     } else {
       throw new Error(`Unknown version ${parsedVersion} for ${engine} on ${platform}
         available versions for ${engine} on ${platform}: ${engineVersions.join(', ')}
+        Make sure you use the latest version of the action with - uses: ruby/setup-ruby@v1
         File an issue at https://github.com/ruby/setup-ruby/issues if would like support for a new version`)
     }
   }
@@ -150,150 +159,4 @@ function envPreInstall() {
   }
 }
 
-function readBundledWithFromGemfileLock(path) {
-  if (fs.existsSync(path)) {
-    const contents = fs.readFileSync(path, 'utf8')
-    const lines = contents.split(/\r?\n/)
-    const bundledWithLine = lines.findIndex(line => /^BUNDLED WITH$/.test(line.trim()))
-    if (bundledWithLine !== -1) {
-      const nextLine = lines[bundledWithLine+1]
-      if (nextLine && /^\d+/.test(nextLine.trim())) {
-        const bundlerVersion = nextLine.trim()
-        const majorVersion = bundlerVersion.match(/^\d+/)[0]
-        console.log(`Using Bundler ${majorVersion} from ${path} BUNDLED WITH ${bundlerVersion}`)
-        return majorVersion
-      }
-    }
-  }
-  return null
-}
-
-async function installBundler(bundlerVersionInput, platform, rubyPrefix, engine, rubyVersion) {
-  var bundlerVersion = bundlerVersionInput
-
-  if (bundlerVersion === 'default' || bundlerVersion === 'Gemfile.lock') {
-    const gemfilePath = `${process.env['BUNDLE_GEMFILE'] || 'Gemfile'}.lock`
-    bundlerVersion = readBundledWithFromGemfileLock(gemfilePath)
-    if (!bundlerVersion) {
-      bundlerVersion = 'latest'
-    }
-  }
-
-  if (bundlerVersion === 'latest') {
-    bundlerVersion = '2'
-  }
-
-  if (/^\d+/.test(bundlerVersion)) {
-    // OK
-  } else {
-    throw new Error(`Cannot parse bundler input: ${bundlerVersion}`)
-  }
-
-  if (rubyVersion.match(/^2\.[12]/)) {
-    console.log('Bundler 2 requires Ruby 2.3+, using Bundler 1 on Ruby <= 2.2')
-    bundlerVersion = '1'
-  } else if (rubyVersion.startsWith('2.3')) {
-    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')
-    bundlerVersion = '1'
-  }
-
-  if (engine === 'ruby' && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
-    console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
-  } else if (engine === 'truffleruby' && bundlerVersion === '1') {
-    console.log(`Using Bundler 1 shipped with ${engine}`)
-  } else if (engine === 'rubinius') {
-    console.log(`Rubinius only supports the version of Bundler shipped with it`)
-  } else {
-    const gem = path.join(rubyPrefix, 'bin', 'gem')
-    await exec.exec(gem, ['install', 'bundler', '-v', `~> ${bundlerVersion}`, '--no-document'])
-  }
-}
-
-async function bundleInstall(platform, engine, version) {
-  if (!fs.existsSync('Gemfile')) {
-    console.log('No Gemfile, skipping "bundle install" and caching')
-    return
-  }
-
-  // config
-  const path = 'vendor/bundle'
-  const hasGemfileLock = fs.existsSync('Gemfile.lock');
-  if (hasGemfileLock) {
-    await exec.exec('bundle', ['config', '--local', 'deployment', 'true'])
-  }
-  await exec.exec('bundle', ['config', '--local', 'path', path])
-
-  // cache key
-  const paths = [path]
-  const baseKey = await computeBaseKey(platform, engine, version)
-  let key = baseKey
-  let restoreKeys
-  if (hasGemfileLock) {
-    key += `-Gemfile.lock-${await common.hashFile('Gemfile.lock')}`
-    // If only Gemfile.lock we can reuse some of the cache (but it will keep old gem versions in the cache)
-    restoreKeys = [`${baseKey}-Gemfile.lock-`]
-  } else {
-    // Only exact key, to never mix native gems of different platforms or Ruby versions
-    restoreKeys = []
-  }
-  console.log(`Cache key: ${key}`)
-
-  // restore cache & install
-  let cachedKey = null
-  try {
-    cachedKey = await cache.restoreCache(paths, key, restoreKeys)
-  } catch (error) {
-    if (error.name === cache.ValidationError.name) {
-      throw error;
-    } else {
-      core.info(`[warning] There was an error restoring the cache ${error.message}`)
-    }
-  }
-
-  if (cachedKey) {
-    console.log(`Found cache for key: ${cachedKey}`)
-  }
-
-  let alreadyInstalled = false
-  if (cachedKey === key) {
-    const exitCode = await exec.exec('bundle', ['check'], { ignoreReturnCode: true })
-    alreadyInstalled = (exitCode === 0)
-  }
-
-  if (!alreadyInstalled) {
-    await exec.exec('bundle', ['install', '--jobs', '4'])
-
-    // Error handling from https://github.com/actions/cache/blob/master/src/save.ts
-    console.log('Saving cache')
-    try {
-      await cache.saveCache(paths, key)
-    } catch (error) {
-      if (error.name === cache.ValidationError.name) {
-        throw error;
-      } else if (error.name === cache.ReserveCacheError.name) {
-        core.info(error.message);
-      } else {
-        core.info(`[warning]${error.message}`)
-      }
-    }
-  }
-}
-
-async function computeBaseKey(platform, engine, version) {
-  let baseKey = `setup-ruby-bundle-install-${platform}-${engine}-${version}`
-  if (engine !== 'jruby' && common.isHeadVersion(version)) {
-    let revision = '';
-    await exec.exec('ruby', ['-e', 'print RUBY_REVISION'], {
-      silent: true,
-      listeners: {
-        stdout: (data) => {
-          revision += data.toString();
-        }
-      }
-    });
-    baseKey += `-revision-${revision}`
-  }
-  return baseKey
-}
-
 if (__filename.endsWith('index.js')) { run() }

package.json

@@ -22,8 +22,8 @@
   },
   "homepage": "https://github.com/ruby/setup-ruby",
   "dependencies": {
-    "@actions/cache": "^1.0.2",
+    "@actions/cache": "^1.0.5",
-    "@actions/core": "^1.2.4",
+    "@actions/core": "^1.2.6",
     "@actions/exec": "^1.0.3",
     "@actions/io": "^1.0.2",
     "@actions/tool-cache": "^1.3.4"

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

@@ -1,32 +1,29 @@
 export function getVersions(platform) {
   const versions = {
     "ruby": [
+      "2.0.0-p648",
       "2.1.9",
       "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.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.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.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", "9.2.18.0",
       "head"
     ],
     "truffleruby": [
       "19.3.0", "19.3.1",
-      "20.0.0", "20.1.0", "20.2.0",
+      "20.0.0", "20.1.0", "20.2.0", "20.3.0",
+      "21.0.0", "21.1.0",
       "head"
     ]
   }
 
-  if (platform === 'ubuntu-18.04') {
-    versions['rubinius'] = [
-      "4.14"
-    ]
-  }
-
   return versions
 }

ruby-builder.js

@@ -6,7 +6,7 @@ const tc = require('@actions/tool-cache')
 const common = require('./common')
 const rubyBuilderVersions = require('./ruby-builder-versions')
 
-const builderReleaseTag = 'enable-shared'
+const builderReleaseTag = 'toolcache'
 const releasesURL = 'https://github.com/ruby/ruby-builder/releases'
 
 const windows = common.windows
@@ -16,22 +16,35 @@ export function getAvailableVersions(platform, engine) {
 }
 
 export async function install(platform, engine, version) {
-  return await downloadAndExtract(platform, engine, version)
+  let rubyPrefix, inToolCache
-}
+  if (common.shouldUseToolCache(engine, version)) {
-
+    inToolCache = tc.find('Ruby', version)
-async function downloadAndExtract(platform, engine, version) {
+    if (inToolCache) {
-  const rubiesDir = windows ? `${common.drive}:` : path.join(os.homedir(), '.rubies')
+      rubyPrefix = inToolCache
-
+    } else {
-  const rubyPrefix = path.join(rubiesDir, `${engine}-${version}`)
+      rubyPrefix = common.getToolCacheRubyPrefix(platform, version)
-
+    }
-  // Set the PATH now, so the MSYS2 'tar' is in Path on Windows
+  } else if (windows) {
-  if (engine === 'rubinius') {
+    rubyPrefix = path.join(`${common.drive}:`, `${engine}-${version}`)
-    common.setupPath([path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')])
   } else {
-    common.setupPath([path.join(rubyPrefix, 'bin')])
+    rubyPrefix = path.join(os.homedir(), '.rubies', `${engine}-${version}`)
   }
 
-  await io.mkdirP(rubiesDir)
+  // Set the PATH now, so the MSYS2 'tar' is in Path on Windows
+  common.setupPath([path.join(rubyPrefix, 'bin')])
+
+  if (!inToolCache) {
+    await downloadAndExtract(platform, engine, version, rubyPrefix);
+  }
+
+  return rubyPrefix
+}
+
+async function downloadAndExtract(platform, engine, version, rubyPrefix) {
+  const parentDir = path.dirname(rubyPrefix)
+
+  await io.rmRF(rubyPrefix)
+  await io.mkdirP(parentDir)
 
   const downloadPath = await common.measure('Downloading Ruby', async () => {
     const url = getDownloadURL(platform, engine, version)
@@ -42,20 +55,29 @@ async function downloadAndExtract(platform, engine, version) {
   await common.measure('Extracting Ruby', async () => {
     if (windows) {
       // Windows 2016 doesn't have system tar, use MSYS2's, it needs unix style paths
-      await exec.exec('tar', [ '-xz', '-C', common.win2nix(rubiesDir), '-f', common.win2nix(downloadPath) ])
+      await exec.exec('tar', ['-xz', '-C', common.win2nix(parentDir), '-f', common.win2nix(downloadPath)])
     } else {
-      await exec.exec('tar', [ '-xz', '-C', rubiesDir, '-f',  downloadPath ])
+      await exec.exec('tar', ['-xz', '-C', parentDir, '-f', downloadPath])
     }
   })
 
-  return rubyPrefix
+  if (common.shouldUseToolCache(engine, version)) {
+    common.createToolCacheCompleteFile(rubyPrefix)
+  }
 }
 
 function getDownloadURL(platform, engine, version) {
+  let builderPlatform = platform
+  if (platform.startsWith('windows-')) {
+    builderPlatform = 'windows-latest'
+  } else if (platform.startsWith('macos-')) {
+    builderPlatform = 'macos-latest'
+  }
+
   if (common.isHeadVersion(version)) {
-    return getLatestHeadBuildURL(platform, engine, version)
+    return getLatestHeadBuildURL(builderPlatform, engine, version)
   } else {
-    return `${releasesURL}/download/${builderReleaseTag}/${engine}-${version}-${platform}.tar.gz`
+    return `${releasesURL}/download/${builderReleaseTag}/${engine}-${version}-${builderPlatform}.tar.gz`
   }
 }
 

versions-strings-for-builder.rb

@@ -3,14 +3,16 @@ versions = eval hash
 
 by_minor = versions[:ruby].group_by { |v| v[/^\d\.\d/] }
 
-p by_minor['2.1']
+(1..7).each do |minor|
-p by_minor['2.2']
-p by_minor['2.3']
-
-(4..7).each do |minor|
   p by_minor["2.#{minor}"].map { |v| "ruby-#{v}" }
 end
 
+puts
+p (versions[:truffleruby] - %w[head]).map { |v| "truffleruby-#{v}" }
+
+puts
 p (versions[:jruby] - %w[head]).map { |v| "jruby-#{v}" }
 
-p (versions[:truffleruby] - %w[head]).map { |v| "truffleruby-#{v}" }
+(versions[:jruby] - %w[head]).each do |v|
+  puts "- { os: windows-latest, jruby-version: #{v}, ruby: jruby-#{v} }"
+end

windows-versions.js

@@ -1,9 +1,10 @@
 export const versions = {
-  "2.1.9": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.1.9-x64-mingw32.7z",
+  "2.0.0": "https://github.com/oneclick/rubyinstaller/releases/download/ruby-2.0.0-p648/ruby-2.0.0-p648-x64-mingw32.7z",
-  "2.2.6": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.2.6-x64-mingw32.7z",
+  "2.1.9": "https://github.com/oneclick/rubyinstaller/releases/download/ruby-2.1.9/ruby-2.1.9-x64-mingw32.7z",
-  "2.3.0": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.3.0-x64-mingw32.7z",
+  "2.2.6": "https://github.com/oneclick/rubyinstaller/releases/download/ruby-2.2.6/ruby-2.2.6-x64-mingw32.7z",
-  "2.3.1": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.3.1-x64-mingw32.7z",
+  "2.3.0": "https://github.com/oneclick/rubyinstaller/releases/download/ruby-2.3.0/ruby-2.3.0-x64-mingw32.7z",
-  "2.3.3": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.3.3-x64-mingw32.7z",
+  "2.3.1": "https://github.com/oneclick/rubyinstaller/releases/download/ruby-2.3.1/ruby-2.3.1-x64-mingw32.7z",
+  "2.3.3": "https://github.com/oneclick/rubyinstaller/releases/download/ruby-2.3.3/ruby-2.3.3-x64-mingw32.7z",
   "2.4.1": "https://github.com/oneclick/rubyinstaller2/releases/download/2.4.1-2/rubyinstaller-2.4.1-2-x64.7z",
   "2.4.2": "https://github.com/oneclick/rubyinstaller2/releases/download/rubyinstaller-2.4.2-2/rubyinstaller-2.4.2-2-x64.7z",
   "2.4.3": "https://github.com/oneclick/rubyinstaller2/releases/download/rubyinstaller-2.4.3-2/rubyinstaller-2.4.3-2-x64.7z",
@@ -19,16 +20,22 @@ export const versions = {
   "2.5.5": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.5.5-1/rubyinstaller-2.5.5-1-x64.7z",
   "2.5.6": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.5.6-1/rubyinstaller-2.5.6-1-x64.7z",
   "2.5.7": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.5.7-1/rubyinstaller-2.5.7-1-x64.7z",
-  "2.5.8": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.5.8-1/rubyinstaller-2.5.8-1-x64.7z",
+  "2.5.8": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.5.8-2/rubyinstaller-2.5.8-2-x64.7z",
+  "2.5.9": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.5.9-1/rubyinstaller-2.5.9-1-x64.7z",
   "2.6.0": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.6.0-1/rubyinstaller-2.6.0-1-x64.7z",
   "2.6.1": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.6.1-1/rubyinstaller-2.6.1-1-x64.7z",
   "2.6.2": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.6.2-1/rubyinstaller-2.6.2-1-x64.7z",
   "2.6.3": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.6.3-1/rubyinstaller-2.6.3-1-x64.7z",
   "2.6.4": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.6.4-1/rubyinstaller-2.6.4-1-x64.7z",
   "2.6.5": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.6.5-1/rubyinstaller-2.6.5-1-x64.7z",
-  "2.6.6": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.6.6-1/rubyinstaller-2.6.6-1-x64.7z",
+  "2.6.6": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.6.6-2/rubyinstaller-2.6.6-2-x64.7z",
+  "2.6.7": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.6.7-1/rubyinstaller-2.6.7-1-x64.7z",
   "2.7.0": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.7.0-1/rubyinstaller-2.7.0-1-x64.7z",
   "2.7.1": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.7.1-1/rubyinstaller-2.7.1-1-x64.7z",
+  "2.7.2": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.7.2-1/rubyinstaller-2.7.2-1-x64.7z",
+  "2.7.3": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-2.7.3-1/rubyinstaller-2.7.3-1-x64.7z",
+  "3.0.0": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.0.0-1/rubyinstaller-3.0.0-1-x64.7z",
+  "3.0.1": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.0.1-1/rubyinstaller-3.0.1-1-x64.7z",
   "head": "https://github.com/oneclick/rubyinstaller2/releases/download/rubyinstaller-head/rubyinstaller-head-x64.7z",
   "mingw": "https://github.com/MSP-Greg/ruby-loco/releases/download/ruby-master/ruby-mingw.7z",
   "mswin": "https://github.com/MSP-Greg/ruby-loco/releases/download/ruby-master/ruby-mswin.7z"

windows.js

@@ -6,16 +6,17 @@ const path = require('path')
 const cp = require('child_process')
 const core = require('@actions/core')
 const exec = require('@actions/exec')
+const io = require('@actions/io')
 const tc = require('@actions/tool-cache')
 const common = require('./common')
 const rubyInstallerVersions = require('./windows-versions').versions
 
 const drive = common.drive
 
-// needed for 2.1, 2.2, 2.3, and mswin, cert file used by Git for Windows
+// needed for 2.0-2.3, and mswin, cert file used by Git for Windows
 const certFile = 'C:\\Program Files\\Git\\mingw64\\ssl\\cert.pem'
 
-// location & path for old RubyInstaller DevKit (MSYS), Ruby 2.1, 2.2 and 2.3
+// location & path for old RubyInstaller DevKit (MSYS), Ruby 2.0-2.3
 const msys = `${drive}:\\DevKit64`
 const msysPathEntries = [`${msys}\\mingw\\x86_64-w64-mingw32\\bin`, `${msys}\\mingw\\bin`, `${msys}\\bin`]
 
@@ -35,27 +36,53 @@ export async function install(platform, engine, version) {
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  const rubyPrefix = `${drive}:\\${base}`
+  let rubyPrefix, inToolCache
+  if (common.shouldUseToolCache(engine, version)) {
+    inToolCache = tc.find('Ruby', version)
+    if (inToolCache) {
+      rubyPrefix = inToolCache
+    } else {
+      rubyPrefix = common.getToolCacheRubyPrefix(platform, version)
+    }
+  } else {
+    rubyPrefix = `${drive}:\\${base}`
+  }
 
   let toolchainPaths = (version === 'mswin') ? await setupMSWin() : await setupMingw(version)
 
   common.setupPath([`${rubyPrefix}\\bin`, ...toolchainPaths])
 
+  if (!inToolCache) {
+    await downloadAndExtract(engine, version, url, base, rubyPrefix);
+  }
+
+  return rubyPrefix
+}
+
+async function downloadAndExtract(engine, version, url, base, rubyPrefix) {
+  const parentDir = path.dirname(rubyPrefix)
+
   const downloadPath = await common.measure('Downloading Ruby', async () => {
     console.log(url)
     return await tc.downloadTool(url)
   })
 
   await common.measure('Extracting Ruby', async () =>
-    exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${drive}:\\`], { silent: true }))
+    exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${parentDir}`], { silent: true }))
 
-  return rubyPrefix
+  if (base !== path.basename(rubyPrefix)) {
+    await io.mv(path.join(parentDir, base), rubyPrefix)
+  }
+
+  if (common.shouldUseToolCache(engine, version)) {
+    common.createToolCacheCompleteFile(rubyPrefix)
+  }
 }
 
 async function setupMingw(version) {
   core.exportVariable('MAKE', 'make.exe')
 
-  if (version.match(/^2\.[123]/)) {
+  if (version.match(/^2\.[0123]/)) {
     core.exportVariable('SSL_CERT_FILE', certFile)
     await common.measure('Installing MSYS', async () => installMSYS(version))
     return msysPathEntries
@@ -64,9 +91,9 @@ async function setupMingw(version) {
   }
 }
 
-// Ruby 2.1, 2.2 and 2.3
+// Ruby 2.0, 2.1, 2.2 and 2.3
 async function installMSYS(version) {
-  const url = 'https://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe'
+  const url = 'https://github.com/oneclick/rubyinstaller/releases/download/devkit-4.7.2/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe'
   const downloadPath = await tc.downloadTool(url)
   await exec.exec('7z', ['x', downloadPath, `-o${msys}`], { silent: true })
 
@@ -109,7 +136,7 @@ export function addVCVARSEnv() {
   let newSet = cp.execSync(cmd).toString().trim().split(/\r?\n/)
   newSet = newSet.filter(line => line.match(/\S=\S/))
   newSet.forEach(s => {
-    let [k,v] = s.split('=', 2)
+    let [k,v] = common.partition(s, '=')
     newEnv.set(k,v)
   })
 

yarn.lock

@@ -2,30 +2,25 @@
 # yarn lockfile v1
 
 
-"@actions/cache@^1.0.2":
+"@actions/cache@^1.0.5":
-  version "1.0.2"
+  version "1.0.5"
-  resolved "https://registry.yarnpkg.com/@actions/cache/-/cache-1.0.2.tgz#a223dcc752c7f988016d28ee7232f930f85cec61"
+  resolved "https://registry.yarnpkg.com/@actions/cache/-/cache-1.0.5.tgz#ba98725d38611b5426fc57a2f00bd8b0d9202f36"
-  integrity sha512-CzAseaJ4cKmOI58EIWUb/LfeYdM7Y25s39OEMtWAhEPrPPzrbSEjGHCLaYjJ0V8C4iojo8vBYh5B3OIJ37EiJw==
+  integrity sha512-TcvJOduwsPP27KLmIa5cqXsQYFK2GzILcEpnhvYmhGwi1aYx9XwhKmp6Im8X6DJMBxbvupKPsOntG6f6sSkIPA==
   dependencies:
-    "@actions/core" "^1.2.4"
+    "@actions/core" "^1.2.6"
     "@actions/exec" "^1.0.1"
     "@actions/glob" "^0.1.0"
-    "@actions/http-client" "^1.0.8"
+    "@actions/http-client" "^1.0.9"
     "@actions/io" "^1.0.1"
     "@azure/ms-rest-js" "^2.0.7"
     "@azure/storage-blob" "^12.1.2"
     semver "^6.1.0"
     uuid "^3.3.3"
 
-"@actions/core@^1.2.0", "@actions/core@^1.2.4":
+"@actions/core@^1.2.0", "@actions/core@^1.2.3", "@actions/core@^1.2.6":
-  version "1.2.4"
+  version "1.2.6"
-  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.2.4.tgz#96179dbf9f8d951dd74b40a0dbd5c22555d186ab"
+  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.2.6.tgz#a78d49f41a4def18e88ce47c2cac615d5694bf09"
-  integrity sha512-YJCEq8BE3CdN8+7HPZ/4DxJjk/OkZV2FFIf+DlZTC/4iBlzYCD5yjRR6eiOS5llO11zbRltIRuKAjMKaWTE6cg==
+  integrity sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==
-
-"@actions/core@^1.2.3":
-  version "1.2.3"
-  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.2.3.tgz#e844b4fa0820e206075445079130868f95bfca95"
-  integrity sha512-Wp4xnyokakM45Uuj4WLUxdsa8fJjKVl1fDTsPbTEcTcuu0Nb26IPQbOtjmnfaCPGcaoPOOqId8H9NapZ8gii4w==
 
 "@actions/exec@^1.0.0", "@actions/exec@^1.0.1", "@actions/exec@^1.0.3":
   version "1.0.4"
@@ -49,6 +44,13 @@
   dependencies:
     tunnel "0.0.6"
 
+"@actions/http-client@^1.0.9":
+  version "1.0.9"
+  resolved "https://registry.yarnpkg.com/@actions/http-client/-/http-client-1.0.9.tgz#af1947d020043dbc6a3b4c5918892095c30ffb52"
+  integrity sha512-0O4SsJ7q+MK0ycvXPl2e6bMXV7dxAXOGjrXS1eTF9s2S401Tp6c/P3c3Joz04QefC1J6Gt942Wl2jbm3f4mLcg==
+  dependencies:
+    tunnel "0.0.6"
+
 "@actions/io@^1.0.1", "@actions/io@^1.0.2":
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/@actions/io/-/io-1.0.2.tgz#2f614b6e69ce14d191180451eb38e6576a6e6b27"
@@ -331,9 +333,9 @@ minimatch@^3.0.4:
     brace-expansion "^1.1.7"
 
 node-fetch@^2.6.0:
-  version "2.6.0"
+  version "2.6.1"
-  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.0.tgz#e633456386d4aa55863f676a7ab0daa8fdecb0fd"
+  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052"
-  integrity sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==
+  integrity sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==
 
 process@^0.11.10:
   version "0.11.10"