Implement automatic bundle install and caching

* Not yet enabled by default.

.github/workflows/release.yml

@@ -0,0 +1,12 @@
+name: Update the v1 branch when a release is published
+on:
+  release:
+    types: [published]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - run: git push origin HEAD:v1

.github/workflows/test.yml

@@ -3,33 +3,45 @@ on:
   pull_request:
   push:
     branches-ignore:
-    - master
     - v1
     tags-ignore:
     - '*'
     paths-ignore:
     - README.md
+  schedule:
+    - cron: '0 7 * * SUN'
 jobs:
-  common:
+  test:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest, macos-latest, windows-latest ]
-        # Use various version syntaxes here for testing
-        ruby: [ 2.2, 2.3, 2.4, 2.5, 2.6.6, 2.7, ruby-head, jruby-9.1, jruby, jruby-head, truffleruby, truffleruby-head ]
+        os: [ ubuntu-16.04, ubuntu-18.04, ubuntu-20.04, macos-10.15, windows-2016, windows-2019 ]
+        # Use various version syntax here for testing
+        ruby: [ 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 }
         exclude:
-        - os: windows-latest
-          ruby: truffleruby
-        - os: windows-latest
-          ruby: truffleruby-head
+        - { os: windows-2016, ruby: debug }
+        - { os: windows-2016, ruby: truffleruby }
+        - { os: windows-2016, ruby: truffleruby-head }
+        - { os: windows-2019, ruby: debug }
+        - { os: windows-2019, ruby: truffleruby }
+        - { os: windows-2019, ruby: truffleruby-head }
+
     name: ${{ matrix.os }} ${{ matrix.ruby }}
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
+
     - uses: ./
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
     - run: ruby -v
+
     - name: build compiler
       run: |
         ruby -e "puts 'build compiler: ' + RbConfig::CONFIG.fetch('CC_VERSION_MESSAGE', 'unknown').lines.first"
@@ -45,19 +57,22 @@ jobs:
             echo 'ridk is unavailable'
           }
         }
+
     - name: Subprocess test
       run: ruby test_subprocess.rb
     - name: OpenSSL version
       run: ruby -ropenssl -e 'puts OpenSSL::OPENSSL_LIBRARY_VERSION'
     - name: OpenSSL test
       run: ruby -ropen-uri -e 'puts open(%{https://rubygems.org/}) { |f| f.read(1024) }'
+
     - name: C extension test
       run: gem install json:2.2.0 --no-document
     - run: bundle --version
     - run: bundle install
     - run: bundle exec rake --version
+
     - name: which ruby, rake
-      if: startsWith(matrix.os, 'windows') == false
+      if: "!startsWith(matrix.os, 'windows')"
       run: which -a ruby rake
     - name: where ruby, rake
       if: startsWith(matrix.os, 'windows')
@@ -71,60 +86,6 @@ jobs:
           echo ''
         }
 
-  specials:
-    strategy:
-      fail-fast: false
-      matrix:
-        cfg:
-        - { ruby: rubinius, os: ubuntu-18.04   }
-        - { ruby: mingw   , os: windows-latest }
-        - { ruby: mswin   , os: windows-latest }
-    name: ${{ matrix.cfg.os }} ${{ matrix.cfg.ruby }}
-    runs-on: ${{ matrix.cfg.os }}
-    steps:
-    - uses: actions/checkout@v2
-    - uses: ./
-      with:
-        ruby-version: ${{ matrix.cfg.ruby }}
-    - run: ruby -v
-    - name: build compiler
-      run: |
-        ruby -e "puts 'build compiler: ' + RbConfig::CONFIG.fetch('CC_VERSION_MESSAGE', 'unknown').lines.first"
-    - name: gcc and ridk version (mingw)
-      if: startsWith(matrix.os, 'windows')
-      run: |
-        $abi, $plat = $(ruby -e "STDOUT.write RbConfig::CONFIG['ruby_version'] + ' ' + RUBY_PLATFORM").split(' ')
-        if ($plat.Contains('mingw')) {
-          gcc --version
-          if ($abi -ge '2.4') {
-            ridk version
-          } else {
-            echo 'ridk is unavailable'
-          }
-        }
-    - name: Subprocess test
-      run: ruby test_subprocess.rb
-    - name: OpenSSL version
-      run: ruby -ropenssl -e 'puts OpenSSL::OPENSSL_LIBRARY_VERSION'
-    - name: OpenSSL test
-      run: ruby -ropen-uri -e 'puts open(%{https://rubygems.org/}) { |f| f.read(1024) }'
-    - name: C extension test
-      run: gem install json:2.2.0 --no-document
-    - run: bundle --version
-    - run: bundle install
-    - run: bundle exec rake --version
-    - name: where ruby, rake
-      if: startsWith(matrix.cfg.os, 'windows')
-      run: |
-        $ErrorActionPreference = 'Continue'
-        $where = 'ruby', 'rake'
-        foreach ($e in $where) {
-          $rslt = where.exe $e 2>&1 | Out-String
-          if ($rslt.contains($e)) { echo $rslt.Trim() }
-          else { echo "Can't find $e" }
-          echo ''
-        }
-
   lint:
     runs-on: ubuntu-latest
     steps:

README.md

@@ -14,11 +14,12 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
 
 | Interpreter | Versions |
 | ----------- | -------- |
-| Ruby | 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, mingw, mswin |
+| Ruby | 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 |
 | JRuby | 9.1.17.0, 9.2.9.0 - 9.2.11.1, head |
-| TruffleRuby | 19.3.0 - 20.0.0, head |
+| TruffleRuby | 19.3.0 - 20.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.  
@@ -32,13 +33,13 @@ On Windows, Ruby 2.4 uses OpenSSL 1.0.2, which is no longer maintained.
 
 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 | Versions |
-| ----------- | -------- |
-| Ubuntu  | `ubuntu-latest` (= `ubuntu-18.04`), `ubuntu-16.04` |
-| macOS   | `macos-latest` |
-| Windows | `windows-latest` |
+| Operating System | Recommended | Other Supported Versions |
+| ----------- | -------- | -------- |
+| Ubuntu  | `ubuntu-latest`  (= `ubuntu-18.04`) | `ubuntu-20.04`, `ubuntu-16.04` |
+| macOS   | `macos-latest`   (= `macos-10.15`)  | |
+| Windows | `windows-latest` (= `windows-2019`) | `windows-2016` |
 
-Rubinius is only available on `ubuntu-latest`.
+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).
@@ -63,13 +64,14 @@ jobs:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
-    - run: ruby -v
+        ruby-version: 2.6 # Not needed with a .ruby-version file
+    - run: bundle install
+    - run: bundle exec rake
 ```
 
 ### Matrix
 
-This matrix tests all stable releases of MRI, JRuby and TruffleRuby on Ubuntu and macOS.
+This matrix tests all stable releases and `head` versions of MRI, JRuby and TruffleRuby on Ubuntu and macOS.
 
 ```yaml
 name: My workflow
@@ -79,17 +81,23 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest, macos-latest ]
-        ruby: [ 2.4, 2.5, 2.6, 2.7, jruby, truffleruby ]
-    runs-on: ${{ matrix.os }}
+        os: [ubuntu, macos]
+        ruby: [2.5, 2.6, 2.7, head, debug, jruby, jruby-head, truffleruby, truffleruby-head]
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - run: ruby -v
+    - run: bundle install
+    - 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).
+
 ### Supported Version Syntax
 
 * engine-version like `ruby-2.6.5` and `truffleruby-19.3.0`
@@ -104,16 +112,35 @@ jobs:
 
 By default, if there is a `Gemfile.lock` file with a `BUNDLED WITH` section,
 the latest version of Bundler with the same major version will be installed.
-Otherwise, the latest Bundler version is installed (except for Ruby 2.2 where only Bundler 1 is supported).
+Otherwise, the latest Bundler version is installed (except for Ruby 2.2 and 2.3 where only Bundler 1 is supported).
 
 This behavior can be customized, see [action.yml](action.yml) for details about the `bundler` input.
 
-### Caching `bundle install`
+### Caching `bundle install` automatically
 
+This action provides a way to automatically run `bundle install` and cache the result:
+```yaml
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+```
+
+This caching speeds up installing gems significantly and avoids too many requests to RubyGems.org.  
+It needs a `Gemfile` under the [`working-directory`](#working-directory).  
+The caching works whether there is a `Gemfile.lock` or not.
+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`.  
+Therefore, the Bundler `path` should not be changed in your workflow for the cache to work.
+
+### Caching `bundle install` manually
+
+You can also cache gems manually,
+but this is not recommended because it is verbose and very difficult to use a correct cache key.
 You can cache the installed gems with these two steps:
 
 ```yaml
-    - uses: actions/cache@v1
+    - uses: actions/cache@v2
       with:
         path: vendor/bundle
         key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
@@ -121,8 +148,9 @@ You can cache the installed gems with these two steps:
           bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-
     - name: bundle install
       run: |
+        bundle config deployment true
         bundle config path vendor/bundle
-        bundle install --jobs 4 --retry 3
+        bundle install --jobs 4
 ```
 
 When using a single OS, replace `${{ matrix.os }}` with the OS.  
@@ -131,9 +159,15 @@ When using `.ruby-version`, replace `${{ matrix.ruby }}` with `${{ hashFiles('.r
 When using `.tool-versions`, replace `${{ matrix.ruby }}` with `${{ hashFiles('.tool-versions') }}`.
 
 This uses the [cache action](https://github.com/actions/cache).
-The code above is a more complete version of the [Ruby - Bundler example](https://github.com/actions/cache/blob/master/examples.md#ruby---bundler).
+The code above is a more complete version of the [Ruby - Bundler example](https://github.com/actions/cache/blob/master/examples.md#ruby---\
+bundler).
 Make sure to include `use-ruby` in the `key` to avoid conflicting with previous caches.
 
+### Working Directory
+
+The `working-directory` input can be set to resolve `.ruby-version`, `.tool-versions` and `Gemfile.lock`
+if they are not at the root of the repository, see [action.yml](action.yml) for details.
+
 ## Windows
 
 Note that running CI on Windows can be quite challenging if you are not very familiar with Windows.
@@ -146,15 +180,22 @@ It is recommended to first get your build working on Ubuntu and macOS before try
 * For Ruby < 2.4, the DevKit MSYS tools are installed and prepended to the `Path`.
 * JRuby on Windows has a known bug that `bundle exec rake` [fails](https://github.com/ruby/setup-ruby/issues/18).
 
-## Limitations
-
-* This action currently only works with GitHub-hosted runners, not private runners.
-
 ## Versioning
 
+It is highly recommended to use `ruby/setup-ruby@v1` for the version of this action.
+This will provide the best experience by automatically getting bug fixes, new Ruby versions and new features.
+
+If you instead choose a specific version (v1.2.3) or a commit sha, there will be no automatic bug fixes and
+it will be your responsibility to update every time the action no longer works.
+Make sure to always use the latest release before reporting an issue on GitHub.
+
 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.
 
+## Limitations
+
+* This action currently only works with GitHub-hosted runners, not private runners.
+
 ## History
 
 This action used to be at `eregon/use-ruby-action` and was moved to the `ruby` organization.
@@ -163,5 +204,5 @@ Please [update](https://github.com/ruby/setup-ruby/releases/tag/v1.13.0) if you
 ## Credits
 
 The current maintainer of this action is @eregon.
-Most of the Windows logic is from https://github.com/MSP-Greg/actions-ruby by MSP-Greg.
+Most of the Windows logic is based on work by MSP-Greg.
 Many thanks to MSP-Greg and Lars Kanis for the help with Ruby Installer.

action.yml

@@ -6,13 +6,21 @@ branding:
   icon: download
 inputs:
   ruby-version:
-    description: 'Engine and version to use, see the syntax in the README. Reads from .ruby-version if unset.'
+    description: 'Engine and version to use, see the syntax in the README. Reads from .ruby-version or .tool-versions if unset.'
     required: false
     default: 'default'
   bundler:
     description: 'The version of Bundler to install. Either none, 1, 2, latest or Gemfile.lock. The default tries Gemfile.lock and otherwise uses latest.'
     required: false
     default: 'default'
+  bundler-cache:
+    description: 'Run "bundle install", and cache the result automatically. Either true or false.'
+    required: false
+    default: 'false'
+  working-directory:
+    description: 'The working directory to use for resolving paths for .ruby-version, .tool-versions and Gemfile.lock.'
+    required: false
+    default: '.'
 outputs:
   ruby-prefix:
     description: 'The prefix of the installed ruby'

common.js

@@ -0,0 +1,64 @@
+const os = require('os')
+const fs = require('fs')
+const util = require('util')
+const stream = require('stream')
+const crypto = require('crypto')
+const core = require('@actions/core')
+const { performance } = require('perf_hooks')
+
+export async function measure(name, block) {
+  return await core.group(name, async () => {
+    const start = performance.now()
+    try {
+      return await block()
+    } finally {
+      const end = performance.now()
+      const duration = (end - start) / 1000.0
+      console.log(`Took ${duration.toFixed(2).padStart(6)} seconds`)
+    }
+  })
+}
+
+export function isHeadVersion(rubyVersion) {
+  return rubyVersion === 'head' || rubyVersion === 'debug' || rubyVersion === 'mingw' || rubyVersion === 'mswin'
+}
+
+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')
+  const pipeline = util.promisify(stream.pipeline)
+  await pipeline(fs.createReadStream(file), hash)
+  return hash.digest('hex')
+}
+
+export function getVirtualEnvironmentName() {
+  const platform = os.platform()
+  if (platform === 'linux') {
+    return `ubuntu-${findUbuntuVersion()}`
+  } else if (platform === 'darwin') {
+    return 'macos-latest'
+  } else if (platform === 'win32') {
+    return 'windows-latest'
+  } else {
+    throw new Error(`Unknown platform ${platform}`)
+  }
+}
+
+function findUbuntuVersion() {
+  const lsb_release = fs.readFileSync('/etc/lsb-release', 'utf8')
+  const match = lsb_release.match(/^DISTRIB_RELEASE=(\d+\.\d+)$/m)
+  if (match) {
+    return match[1]
+  } else {
+    throw new Error('Could not find Ubuntu version')
+  }
+}
+
+// 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]}`
+  }
+  return path.replace(/\\/g, '/').replace(/ /g, '\\ ')
+}

index.js

@@ -3,36 +3,65 @@ 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 inputDefaults = {
+  'ruby-version': 'default',
+  'bundler': 'default',
+  'bundler-cache': 'true',
+  'working-directory': '.',
+}
 
 export async function run() {
   try {
-    const platform = getVirtualEnvironmentName()
-    const [engine, version] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
-
-    let installer
-    if (platform === 'windows-latest' && engine !== 'jruby') {
-      installer = require('./windows')
-    } else {
-      installer = require('./ruby-builder')
+    const options = {}
+    for (const key in inputDefaults) {
+      options[key] = core.getInput(key)
     }
-
-    const engineVersions = installer.getAvailableVersions(platform, engine)
-    const ruby = validateRubyEngineAndVersion(platform, engineVersions, engine, version)
-
-    createGemRC()
-
-    const [rubyPrefix, newPathEntries] = await installer.install(platform, ruby)
-
-    setupPath(ruby, newPathEntries)
-
-    await installBundler(platform, rubyPrefix, engine, version)
-
-    core.setOutput('ruby-prefix', rubyPrefix)
+    await setupRuby(options)
   } catch (error) {
     core.setFailed(error.message)
   }
 }
 
+export async function setupRuby(options) {
+  const inputs = { ...inputDefaults, ...options }
+
+  process.chdir(inputs['working-directory'])
+
+  const platform = common.getVirtualEnvironmentName()
+  const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
+
+  let installer
+  if (platform === 'windows-latest' && engine !== 'jruby') {
+    installer = require('./windows')
+  } else {
+    installer = require('./ruby-builder')
+  }
+
+  const engineVersions = installer.getAvailableVersions(platform, engine)
+  const version = validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion)
+
+  createGemRC()
+
+  const [rubyPrefix, newPathEntries] = await installer.install(platform, engine, version)
+
+  setupPath(newPathEntries)
+
+  if (inputs['bundler'] !== 'none') {
+    await common.measure('Installing Bundler', async () =>
+      installBundler(inputs['bundler'], platform, rubyPrefix, engine, version))
+
+    if (inputs['bundler-cache'] === 'true') {
+      await common.measure('bundle install', async () =>
+          bundleInstall(platform, engine, version))
+    }
+  }
+
+  core.setOutput('ruby-prefix', rubyPrefix)
+}
+
 function parseRubyEngineAndVersion(rubyVersion) {
   if (rubyVersion === 'default') {
     if (fs.existsSync('.ruby-version')) {
@@ -55,7 +84,7 @@ function parseRubyEngineAndVersion(rubyVersion) {
   }
 
   let engine, version
-  if (rubyVersion.match(/^(\d+|head|mingw|mswin)/)) { // X.Y.Z => ruby-X.Y.Z
+  if (rubyVersion.match(/^(\d+)/) || common.isHeadVersion(rubyVersion)) { // X.Y.Z => ruby-X.Y.Z
     engine = 'ruby'
     version = rubyVersion
   } else if (!rubyVersion.includes('-')) { // myruby -> myruby-stableVersion
@@ -68,24 +97,25 @@ function parseRubyEngineAndVersion(rubyVersion) {
   return [engine, version]
 }
 
-function validateRubyEngineAndVersion(platform, engineVersions, engine, version) {
+function validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion) {
   if (!engineVersions) {
     throw new Error(`Unknown engine ${engine} on ${platform}`)
   }
 
-  if (!engineVersions.includes(version)) {
+  let version = parsedVersion
+  if (!engineVersions.includes(parsedVersion)) {
     const latestToFirstVersion = engineVersions.slice().reverse()
-    const found = latestToFirstVersion.find(v => v !== 'head' && v.startsWith(version))
+    const found = latestToFirstVersion.find(v => !common.isHeadVersion(v) && v.startsWith(parsedVersion))
     if (found) {
       version = found
     } else {
-      throw new Error(`Unknown version ${version} for ${engine} on ${platform}
+      throw new Error(`Unknown version ${parsedVersion} for ${engine} on ${platform}
         available versions for ${engine} on ${platform}: ${engineVersions.join(', ')}
         File an issue at https://github.com/ruby/setup-ruby/issues if would like support for a new version`)
     }
   }
 
-  return engine + '-' + version
+  return version
 }
 
 function createGemRC() {
@@ -95,20 +125,22 @@ function createGemRC() {
   }
 }
 
-function setupPath(ruby, newPathEntries) {
-    const originalPath = process.env['PATH'].split(path.delimiter)
-    let cleanPath = originalPath.filter(entry => !/\bruby\b/i.test(entry))
+function setupPath(newPathEntries) {
+  const originalPath = process.env['PATH'].split(path.delimiter)
+  let cleanPath = originalPath.filter(entry => !/\bruby\b/i.test(entry))
 
-    if (cleanPath.length !== originalPath.length) {
-        console.log("Entries removed from PATH to avoid conflicts with Ruby:")
-        for (const entry of originalPath) {
-            if (!cleanPath.includes(entry)) {
-                console.log(`  ${entry}`)
-            }
-        }
+  if (cleanPath.length !== originalPath.length) {
+    core.startGroup('Cleaning PATH')
+    console.log('Entries removed from PATH to avoid conflicts with Ruby:')
+    for (const entry of originalPath) {
+      if (!cleanPath.includes(entry)) {
+        console.log(`  ${entry}`)
+      }
     }
+    core.endGroup()
+  }
 
-    core.exportVariable('PATH', [...newPathEntries, ...cleanPath].join(path.delimiter))
+  core.exportVariable('PATH', [...newPathEntries, ...cleanPath].join(path.delimiter))
 }
 
 function readBundledWithFromGemfileLock() {
@@ -129,11 +161,8 @@ function readBundledWithFromGemfileLock() {
   return null
 }
 
-async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
-  var bundlerVersion = core.getInput('bundler')
-  if (bundlerVersion === 'none') {
-    return
-  }
+async function installBundler(bundlerVersionInput, platform, rubyPrefix, engine, rubyVersion) {
+  var bundlerVersion = bundlerVersionInput
 
   if (bundlerVersion === 'default' || bundlerVersion === 'Gemfile.lock') {
     bundlerVersion = readBundledWithFromGemfileLock()
@@ -142,48 +171,111 @@ async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
     }
   }
 
-  let versionArray
-  if (rubyVersion.startsWith('2.2')) {
-    console.log('Bundler 2 requires Ruby 2.3+, using Bundler 1 on Ruby 2.2')
-    versionArray = ['-v', '~> 1']
-  } else if (/^\d+/.test(bundlerVersion)) {
-    versionArray = ['-v', `~> ${bundlerVersion}`]
-  } else if (bundlerVersion === 'latest') {
-    versionArray = []
+  if (bundlerVersion === 'latest') {
+    bundlerVersion = '2'
+  }
+
+  if (/^\d+/.test(bundlerVersion)) {
+    // OK
   } else {
     throw new Error(`Cannot parse bundler input: ${bundlerVersion}`)
   }
 
-  if (engine === 'rubinius') {
+  if (rubyVersion.startsWith('2.2')) {
+    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 if (bundlerVersion === '1' && engine === 'truffleruby') {
-    console.log(`Using the Bundler version shipped with ${engine}`)
   } else {
-    await exec.exec(path.join(rubyPrefix, 'bin', 'gem'), ['install', 'bundler', ...versionArray, '--no-document'])
+    const gem = path.join(rubyPrefix, 'bin', 'gem')
+    await exec.exec(gem, ['install', 'bundler', '-v', `~> ${bundlerVersion}`, '--no-document'])
   }
 }
 
-function getVirtualEnvironmentName() {
-  const platform = os.platform()
-  if (platform === 'linux') {
-    return `ubuntu-${findUbuntuVersion()}`
-  } else if (platform === 'darwin') {
-    return 'macos-latest'
-  } else if (platform === 'win32') {
-    return 'windows-latest'
+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 {
-    throw new Error(`Unknown platform ${platform}`)
+    // Only exact key, to never mix native gems of different platforms or Ruby versions
+    restoreKeys = []
+  }
+  console.log(`Cache key: ${key}`)
+
+  // restore cache & install
+  const cachedKey = await cache.restoreCache(paths, key, restoreKeys)
+  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}`)
+      }
+    }
   }
 }
 
-function findUbuntuVersion() {
-  const lsb_release = fs.readFileSync('/etc/lsb-release', 'utf8')
-  const match = lsb_release.match(/^DISTRIB_RELEASE=(\d+\.\d+)$/m)
-  if (match) {
-    return match[1]
-  } else {
-    throw new Error('Could not find Ubuntu version')
+async function computeBaseKey(platform, engine, version) {
+  let baseKey = `setup-ruby-bundle-install-${platform}-${engine}-${version}`
+  if (engine === 'ruby' && 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

@@ -26,7 +26,8 @@
     "@actions/core": "^1.2.3",
     "@actions/exec": "^1.0.3",
     "@actions/io": "^1.0.2",
-    "@actions/tool-cache": "^1.3.1"
+    "@actions/tool-cache": "^1.3.1",
+    "@actions/cache": "^0.2.1"
   },
   "devDependencies": {
     "@zeit/ncc": "^0.21.1"

ruby-builder-versions.js

@@ -7,7 +7,7 @@ export function getVersions(platform) {
       "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.6.0", "2.6.1", "2.6.2", "2.6.3", "2.6.4", "2.6.5", "2.6.6",
       "2.7.0", "2.7.1",
-      "head"
+      "head", "debug",
     ],
     "jruby": [
       "9.1.17.0",
@@ -16,7 +16,7 @@ export function getVersions(platform) {
     ],
     "truffleruby": [
       "19.3.0", "19.3.1",
-      "20.0.0",
+      "20.0.0", "20.1.0",
       "head"
     ]
   }

ruby-builder.js

@@ -3,6 +3,7 @@ const path = require('path')
 const exec = require('@actions/exec')
 const io = require('@actions/io')
 const tc = require('@actions/tool-cache')
+const common = require('./common')
 const rubyBuilderVersions = require('./ruby-builder-versions')
 
 const builderReleaseTag = 'enable-shared'
@@ -12,10 +13,10 @@ export function getAvailableVersions(platform, engine) {
   return rubyBuilderVersions.getVersions(platform)[engine]
 }
 
-export async function install(platform, ruby) {
-  const rubyPrefix = await downloadAndExtract(platform, ruby)
+export async function install(platform, engine, version) {
+  const rubyPrefix = await downloadAndExtract(platform, engine, version)
   let newPathEntries
-  if (ruby.startsWith('rubinius')) {
+  if (engine === 'rubinius') {
     newPathEntries = [path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')]
   } else {
     newPathEntries = [path.join(rubyPrefix, 'bin')]
@@ -23,29 +24,37 @@ export async function install(platform, ruby) {
   return [rubyPrefix, newPathEntries]
 }
 
-async function downloadAndExtract(platform, ruby) {
+async function downloadAndExtract(platform, engine, version) {
   const rubiesDir = path.join(os.homedir(), '.rubies')
   await io.mkdirP(rubiesDir)
 
-  const url = await getDownloadURL(platform, ruby)
-  console.log(url)
+  const downloadPath = await common.measure('Downloading Ruby', async () => {
+    const url = getDownloadURL(platform, engine, version)
+    console.log(url)
+    return await tc.downloadTool(url)
+  })
 
-  const downloadPath = await tc.downloadTool(url)
-  const tar = platform.startsWith('windows') ? 'C:\\Windows\\system32\\tar.exe' : 'tar'
-  await exec.exec(tar, [ '-xz', '-C', rubiesDir, '-f',  downloadPath ])
+  await common.measure('Extracting Ruby', async () => {
+    if (process.env.ImageOS === 'win16') {
+      const tar = '"C:\\Program Files\\Git\\usr\\bin\\tar.exe"'
+      await exec.exec(tar, [ '-xz', '-C', common.win2nix(rubiesDir), '-f', common.win2nix(downloadPath) ])
+    } else {
+      const tar = platform.startsWith('windows') ? 'C:\\Windows\\system32\\tar.exe' : 'tar'
+      await exec.exec(tar, [ '-xz', '-C', rubiesDir, '-f',  downloadPath ])
+    }
+  })
 
-  return path.join(rubiesDir, ruby)
+  return path.join(rubiesDir, `${engine}-${version}`)
 }
 
-function getDownloadURL(platform, ruby) {
-  if (ruby.endsWith('-head')) {
-    return getLatestHeadBuildURL(platform, ruby)
+function getDownloadURL(platform, engine, version) {
+  if (common.isHeadVersion(version)) {
+    return getLatestHeadBuildURL(platform, engine, version)
   } else {
-    return `${releasesURL}/download/${builderReleaseTag}/${ruby}-${platform}.tar.gz`
+    return `${releasesURL}/download/${builderReleaseTag}/${engine}-${version}-${platform}.tar.gz`
   }
 }
 
-function getLatestHeadBuildURL(platform, ruby) {
-  const engine = ruby.split('-')[0]
-  return `https://github.com/ruby/${engine}-dev-builder/releases/latest/download/${engine}-head-${platform}.tar.gz`
+function getLatestHeadBuildURL(platform, engine, version) {
+  return `https://github.com/ruby/${engine}-dev-builder/releases/latest/download/${engine}-${version}-${platform}.tar.gz`
 }

versions-strings-for-builder.rb

@@ -0,0 +1,15 @@
+hash = File.read('ruby-builder-versions.js')[/\bversions = {[^}]+}/]
+versions = eval hash
+
+by_minor = versions[:ruby].group_by { |v| v[/^\d\.\d/] }
+
+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
+
+p (versions[:jruby] - %w[head]).map { |v| "jruby-#{v}" }
+
+p (versions[:truffleruby] - %w[head]).map { |v| "truffleruby-#{v}" }

windows.js

@@ -7,6 +7,7 @@ const cp = require('child_process')
 const core = require('@actions/core')
 const exec = require('@actions/exec')
 const tc = require('@actions/tool-cache')
+const common = require('./common')
 const rubyInstallerVersions = require('./windows-versions').versions
 
 // Extract to SSD, see https://github.com/ruby/setup-ruby/pull/14
@@ -32,18 +33,21 @@ export function getAvailableVersions(platform, engine) {
   }
 }
 
-export async function install(platform, ruby) {
-  const version = ruby.split('-', 2)[1]
+export async function install(platform, engine, version) {
   const url = rubyInstallerVersions[version]
-  console.log(url)
 
   if (!url.endsWith('.7z')) {
-    throw new Error('URL should end in .7z')
+    throw new Error(`URL should end in .7z: ${url}`)
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  const downloadPath = await tc.downloadTool(url)
-  await exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${drive}:\\`], { silent: true })
+  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 }))
   const rubyPrefix = `${drive}:\\${base}`
 
   let toolchainPaths = (version === 'mswin') ?
@@ -62,7 +66,8 @@ async function symLinkToEmbeddedMSYS2() {
   }
   const latestVersion = toolCacheVersions.slice(-1)[0]
   const hostedRuby = tc.find('Ruby', latestVersion)
-  await exec.exec(`cmd /c mklink /D ${msys2} ${hostedRuby}\\msys64`)
+  await common.measure('Linking MSYS2', async () =>
+    exec.exec(`cmd /c mklink /D ${msys2} ${hostedRuby}\\msys64`))
 }
 
 async function setupMingw(version) {
@@ -70,7 +75,8 @@ async function setupMingw(version) {
 
   if (version.startsWith('2.2') || version.startsWith('2.3')) {
     core.exportVariable('SSL_CERT_FILE', certFile)
-    await installMSYS(version)
+    await common.measure('Installing MSYS1', async () =>
+      installMSYS(version))
 
     return msysPathEntries
   } else {
@@ -117,7 +123,10 @@ async function setupMSWin() {
     await symLinkToEmbeddedMSYS2()
   }
 
-  return [...addVCVARSEnv(), ...msys2PathEntries]
+  const VCPathEntries = await common.measure('Setting up MSVC environment', async () =>
+    addVCVARSEnv())
+
+  return [...VCPathEntries, ...msys2PathEntries]
 }
 
 /* Sets MSVC environment for use in Actions

yarn.lock

@@ -2,22 +2,48 @@
 # yarn lockfile v1
 
 
+"@actions/cache@^0.2.1":
+  version "0.2.1"
+  resolved "https://registry.yarnpkg.com/@actions/cache/-/cache-0.2.1.tgz#3ea5b0fc86f4f115a6d46c57d2d473f9eadf92aa"
+  integrity sha512-CV2D9zp+d+nL7o6XK/I7vVh350JglPMp/jHi9ppRUkdBHPUeP0UHVUfygZaAs8WmxhhWY1MI0gWah+t0QYu3Fg==
+  dependencies:
+    "@actions/core" "^1.2.4"
+    "@actions/exec" "^1.0.1"
+    "@actions/glob" "^0.1.0"
+    "@actions/http-client" "^1.0.8"
+    "@actions/io" "^1.0.1"
+    semver "^6.1.0"
+    uuid "^3.3.3"
+
 "@actions/core@^1.2.0", "@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.3":
-  version "1.0.3"
-  resolved "https://registry.yarnpkg.com/@actions/exec/-/exec-1.0.3.tgz#b967f8700d6ff011dcc91243b58bafc1bb9ab95f"
-  integrity sha512-TogJGnueOmM7ntCi0ASTUj4LapRRtDfj57Ja4IhPmg2fls28uVOPbAn8N+JifaOumN2UG3oEO/Ixek2A4NcYSA==
+"@actions/core@^1.2.4":
+  version "1.2.4"
+  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.2.4.tgz#96179dbf9f8d951dd74b40a0dbd5c22555d186ab"
+  integrity sha512-YJCEq8BE3CdN8+7HPZ/4DxJjk/OkZV2FFIf+DlZTC/4iBlzYCD5yjRR6eiOS5llO11zbRltIRuKAjMKaWTE6cg==
+
+"@actions/exec@^1.0.0", "@actions/exec@^1.0.1", "@actions/exec@^1.0.3":
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/@actions/exec/-/exec-1.0.4.tgz#99d75310e62e59fc37d2ee6dcff6d4bffadd3a5d"
+  integrity sha512-4DPChWow9yc9W3WqEbUj8Nr86xkpyE29ZzWjXucHItclLbEW6jr80Zx4nqv18QL6KK65+cifiQZXvnqgTV6oHw==
   dependencies:
     "@actions/io" "^1.0.1"
 
-"@actions/http-client@^1.0.3":
-  version "1.0.6"
-  resolved "https://registry.yarnpkg.com/@actions/http-client/-/http-client-1.0.6.tgz#6f9267ca50e1d74d8581f4a894a943cd4c97b49a"
-  integrity sha512-LGmio4w98UyGX33b/W6V6Nx/sQHRXZ859YlMkn36wPsXPB82u8xTVlA/Dq2DXrm6lEq9RVmisRJa1c+HETAIJA==
+"@actions/glob@^0.1.0":
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/@actions/glob/-/glob-0.1.0.tgz#969ceda7e089c39343bca3306329f41799732e40"
+  integrity sha512-lx8SzyQ2FE9+UUvjqY1f28QbTJv+w8qP7kHHbfQRhphrlcx0Mdmm1tZdGJzfxv1jxREa/sLW4Oy8CbGQKCJySA==
+  dependencies:
+    "@actions/core" "^1.2.0"
+    minimatch "^3.0.4"
+
+"@actions/http-client@^1.0.8":
+  version "1.0.8"
+  resolved "https://registry.yarnpkg.com/@actions/http-client/-/http-client-1.0.8.tgz#8bd76e8eca89dc8bcf619aa128eba85f7a39af45"
+  integrity sha512-G4JjJ6f9Hb3Zvejj+ewLLKLf99ZC+9v+yCxoYf9vSyH+WkzPLB2LuUtRMGNkooMqdugGBFStIKXOuvH1W+EctA==
   dependencies:
     tunnel "0.0.6"
 
@@ -27,13 +53,13 @@
   integrity sha512-J8KuFqVPr3p6U8W93DOXlXW6zFvrQAJANdS+vw0YhusLIq+bszW8zmK2Fh1C2kDPX8FMvwIl1OUcFgvJoXLbAg==
 
 "@actions/tool-cache@^1.3.1":
-  version "1.3.3"
-  resolved "https://registry.yarnpkg.com/@actions/tool-cache/-/tool-cache-1.3.3.tgz#34cf87a0436a2178207a644932114a236194b0fd"
-  integrity sha512-AFVyTLcIxusDVI1gMhbZW8m/On7YNJG+xYaxorV+qic+f7lO7h37aT2mfzxqAq7mwHxtP1YlVFNrXe9QDf/bPg==
+  version "1.3.4"
+  resolved "https://registry.yarnpkg.com/@actions/tool-cache/-/tool-cache-1.3.4.tgz#2d2e3d109696edc7c12b0bd47ab6f66446428246"
+  integrity sha512-1Pfz4vDbKzqsWOi5CdNl377cwBNfsNrV3Wy8i94mw+49T+6JVqAH3gtFj/Woe93zyvlvzqM0rmQlPh5+jvKLag==
   dependencies:
     "@actions/core" "^1.2.0"
     "@actions/exec" "^1.0.0"
-    "@actions/http-client" "^1.0.3"
+    "@actions/http-client" "^1.0.8"
     "@actions/io" "^1.0.1"
     semver "^6.1.0"
     uuid "^3.3.2"
@@ -43,6 +69,31 @@
   resolved "https://registry.yarnpkg.com/@zeit/ncc/-/ncc-0.21.1.tgz#44fd4359c54ba34a018a5ccf7a315489db20a733"
   integrity sha512-M9WzgquSOt2nsjRkYM9LRylBLmmlwNCwYbm3Up3PDEshfvdmIfqpFNSK8EJvR18NwZjGHE5z2avlDtYQx2JQnw==
 
+balanced-match@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767"
+  integrity sha1-ibTRmasr7kneFk6gK4nORi1xt2c=
+
+brace-expansion@^1.1.7:
+  version "1.1.11"
+  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd"
+  integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==
+  dependencies:
+    balanced-match "^1.0.0"
+    concat-map "0.0.1"
+
+concat-map@0.0.1:
+  version "0.0.1"
+  resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
+  integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=
+
+minimatch@^3.0.4:
+  version "3.0.4"
+  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083"
+  integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==
+  dependencies:
+    brace-expansion "^1.1.7"
+
 semver@^6.1.0:
   version "6.3.0"
   resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
@@ -53,7 +104,7 @@ tunnel@0.0.6:
   resolved "https://registry.yarnpkg.com/tunnel/-/tunnel-0.0.6.tgz#72f1314b34a5b192db012324df2cc587ca47f92c"
   integrity sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==
 
-uuid@^3.3.2:
+uuid@^3.3.2, uuid@^3.3.3:
   version "3.4.0"
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.4.0.tgz#b23e4358afa8a202fe7a100af1f5f883f02007ee"
   integrity sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==