Update to latest actions/cache to fix cache saving on Windows with MSYS2 tar

* See https://github.com/actions/toolkit/issues/632
* Fixes https://github.com/ruby/setup-ruby/issues/102

.github/workflows/test.yml

@@ -17,22 +17,21 @@ jobs:
       matrix:
         os: [ ubuntu-16.04, ubuntu-18.04, ubuntu-20.04, macos-10.15, macos-11.0, windows-2016, windows-2019 ]
         # Use various version syntax here for testing
-        ruby: [ 2.1, 2.2, 2.3, 2.4, 2.5, 2.6.6, 2.7, ruby-3.0.0-preview1, ruby-head, debug, jruby-9.1, jruby, jruby-head, truffleruby, truffleruby-head ]
+        ruby: [ 2.1, 2.2, 2.3, 2.4, 2.5, 2.6.6, 2.7, '3.0', ruby-head, debug, jruby-9.1, jruby, jruby-head, truffleruby, truffleruby-head ]
         include:
         - { os: windows-2016, ruby: mingw }
         - { os: windows-2019, ruby: mingw }
         - { os: windows-2019, ruby: mswin }
         exclude:
-        - { os: windows-2016, ruby: ruby-3.0.0-preview1 }
+        - { os: windows-2016, ruby: '3.0' }
         - { os: windows-2016, ruby: debug }
         - { os: windows-2016, ruby: truffleruby }
         - { os: windows-2016, ruby: truffleruby-head }
-        - { os: windows-2019, ruby: ruby-3.0.0-preview1 }
+        - { os: windows-2019, ruby: '3.0' }
         - { os: windows-2019, ruby: debug }
         - { os: windows-2019, ruby: truffleruby }
         - { os: windows-2019, ruby: truffleruby-head }
         - { os: macos-11.0, ruby: truffleruby }
-        - { os: macos-11.0, ruby: truffleruby-head }
 
     name: ${{ matrix.os }} ${{ matrix.ruby }}
     runs-on: ${{ matrix.os }}
@@ -103,10 +102,21 @@ jobs:
       if: startsWith(matrix.os, 'windows') && startsWith(matrix.ruby, 'jruby')
       run: gem install sassc -N
 
-  lint:
+  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.1.4
+    - run: bundle --version | grep -F 2.1.4
+
+  lint:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
     - run: yarn install
     - run: yarn run package
     - name: Check generated files are up to date

README.md

@@ -14,9 +14,9 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
 
 | Interpreter | Versions |
 | ----------- | -------- |
-| Ruby | 2.1.9, 2.2, 2.3.0 - 2.3.8, 2.4.0 - 2.4.10, 2.5.0 - 2.5.8, 2.6.0 - 2.6.6, 2.7.2, head, debug, mingw, mswin |
-| JRuby | 9.1.17.0, 9.2.9.0 - 9.2.13.0, head |
-| TruffleRuby | 19.3.0 - 20.2.0, head |
+| `ruby` | 2.1.9, 2.2, 2.3.0 - 2.3.8, 2.4.0 - 2.4.10, 2.5.0 - 2.5.8, 2.6.0 - 2.6.6, 2.7.2, head, debug, mingw, mswin |
+| `jruby` | 9.1.17.0, 9.2.9.0 - 9.2.13.0, head |
+| `truffleruby` | 19.3.0 - 20.3.0, head |
 
 `ruby-debug` is the same as `ruby-head` but with assertions enabled (`-DRUBY_DEBUG=1`).  
 On Windows, `mingw` and `mswin` are `ruby-head` builds using the MSYS2/MinGW and the MSVC toolchains respectively.
@@ -85,7 +85,6 @@ jobs:
         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
@@ -137,6 +136,23 @@ This caching speeds up installing gems significantly and avoids too many request
 It needs a `Gemfile` (or `$BUNDLE_GEMFILE` or `gems.rb`) under the [`working-directory`](#working-directory).  
 If there is a `Gemfile.lock` (or `$BUNDLE_GEMFILE.lock` or `gems.locked`), `bundle config --local deployment true` is used.
 
+To use a `Gemfile` which is not at the root or has a different name, set `BUNDLE_GEMFILE` in the `env` at the job level, so it is set for all steps:
+```yaml
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: subdir/mygemfile
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+        bundler-cache: true
+    - run: bundle exec rake
+```
+Of course you can also use a matrix of gemfiles if you need to test multiple gemfiles.
+
 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 (no `bundle config path`).
 

action.yml

@@ -11,7 +11,7 @@ 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 Gemfile.lock, $BUNDLE_GEMFILE.lock or gems.locked.
       Defaults to 'Gemfile.lock' if the file exists and 'latest' otherwise.
     required: false

common.js

@@ -40,6 +40,25 @@ 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)
+  } 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')
@@ -77,7 +96,7 @@ export function getVirtualEnvironmentName() {
   throw new Error(`Unknown ImageOS ${imageOS}`)
 }
 
-export function shouldExtractInToolCache(engine, version) {
+export function shouldUseToolCache(engine, version) {
   return engine === 'ruby' && !isHeadVersion(version)
 }
 
@@ -99,6 +118,11 @@ export function getToolCacheRubyPrefix(platform, version) {
   return path.join(toolCache, 'Ruby', version, 'x64')
 }
 
+export function createToolCacheCompleteFile(toolCacheRubyPrefix) {
+  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)) {

index.js

@@ -63,12 +63,12 @@ export async function setupRuby(options = {}) {
   if (inputs['bundler'] !== 'none') {
     const [gemfile, lockFile] = detectGemfiles()
 
-    await common.measure('Installing Bundler', async () =>
+    const bundlerVersion = await common.measure('Installing Bundler', async () =>
       installBundler(inputs['bundler'], lockFile, platform, rubyPrefix, engine, version))
 
     if (inputs['bundler-cache'] === 'true') {
       await common.measure('bundle install', async () =>
-          bundleInstall(gemfile, lockFile, platform, engine, version))
+          bundleInstall(gemfile, lockFile, platform, engine, version, bundlerVersion))
     }
   }
 
@@ -132,7 +132,13 @@ function validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVe
   let version = parsedVersion
   if (!engineVersions.includes(parsedVersion)) {
     const latestToFirstVersion = engineVersions.slice().reverse()
-    const found = latestToFirstVersion.find(v => common.isStableVersion(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 {
@@ -175,9 +181,8 @@ function readBundledWithFromGemfileLock(lockFile) {
       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 ${lockFile} BUNDLED WITH ${bundlerVersion}`)
-        return majorVersion
+        console.log(`Using Bundler ${bundlerVersion} from ${lockFile} BUNDLED WITH ${bundlerVersion}`)
+        return bundlerVersion
       }
     }
   }
@@ -205,7 +210,7 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     throw new Error(`Cannot parse bundler input: ${bundlerVersion}`)
   }
 
-  if (engine === 'ruby' && rubyVersion.match(/^2\.[12]/)) {
+  if (engine === 'ruby' && rubyVersion.match(/^2\.[012]/)) {
     console.log('Bundler 2 requires Ruby 2.3+, using Bundler 1 on Ruby <= 2.2')
     bundlerVersion = '1'
   } else if (engine === 'ruby' && rubyVersion.startsWith('2.3')) {
@@ -216,40 +221,50 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     bundlerVersion = '1'
   }
 
-  if ((engine === 'ruby' || engine === 'truffleruby') && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
+  if (common.isHeadVersion(rubyVersion) && common.isBundler2Default(engine, rubyVersion) && bundlerVersion.startsWith('2')) {
     console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
-  } else if (engine === 'truffleruby' && !common.isHeadVersion(rubyVersion) && bundlerVersion === '1') {
+  } 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')
     await exec.exec(gem, ['install', 'bundler', '-v', `~> ${bundlerVersion}`, '--no-document'])
   }
+
+  return bundlerVersion
 }
 
-async function bundleInstall(gemfile, lockFile, platform, engine, version) {
+async function bundleInstall(gemfile, lockFile, platform, engine, rubyVersion, bundlerVersion) {
   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 path = 'vendor/bundle'
 
-  await exec.exec('bundle', ['config', '--local', 'path', path])
+  await exec.exec('bundle', ['config', '--local', 'path', path], envOptions)
 
   if (fs.existsSync(lockFile)) {
-    await exec.exec('bundle', ['config', '--local', 'deployment', 'true'])
+    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'])
+    await exec.exec('bundle', ['lock'], envOptions)
   }
 
   // cache key
   const paths = [path]
-  const baseKey = await computeBaseKey(platform, engine, version, lockFile)
+  const baseKey = await computeBaseKey(platform, engine, rubyVersion, lockFile)
   const key = `${baseKey}-${await common.hashFile(lockFile)}`
-  // If only Gemfile.lock changes we can reuse part of the cache (but it will keep old gem versions in the cache)
+  // 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}`)
 
@@ -274,6 +289,10 @@ async function bundleInstall(gemfile, lockFile, platform, engine, version) {
 
   // @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 {

package.json

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

ruby-builder-versions.js

@@ -8,17 +8,17 @@ 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", "2.7.2",
-      "3.0.0-preview1",
+      "3.0.0-preview1", "3.0.0-preview2",
       "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",
       "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",
       "head"
     ]
   }

ruby-builder.js

@@ -1,6 +1,5 @@
 const os = require('os')
 const path = require('path')
-const core = require('@actions/core')
 const exec = require('@actions/exec')
 const io = require('@actions/io')
 const tc = require('@actions/tool-cache')
@@ -17,24 +16,33 @@ export function getAvailableVersions(platform, engine) {
 }
 
 export async function install(platform, engine, version) {
-  return await downloadAndExtract(platform, engine, version)
-}
-
-async function downloadAndExtract(platform, engine, version) {
-  let rubyPrefix
-  if (common.shouldExtractInToolCache(engine, version)) {
-    rubyPrefix = common.getToolCacheRubyPrefix(platform, version)
+  let rubyPrefix, inToolCache
+  if (common.shouldUseToolCache(engine, version)) {
+    inToolCache = tc.find('Ruby', version)
+    if (inToolCache) {
+      rubyPrefix = inToolCache
+    } else {
+      rubyPrefix = common.getToolCacheRubyPrefix(platform, version)
+    }
   } else if (windows) {
     rubyPrefix = path.join(`${common.drive}:`, `${engine}-${version}`)
   } else {
     rubyPrefix = path.join(os.homedir(), '.rubies', `${engine}-${version}`)
   }
 
-  const parentDir = path.dirname(rubyPrefix)
-
   // 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)
 
@@ -47,13 +55,15 @@ 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(parentDir), '-f', common.win2nix(downloadPath) ])
+      await exec.exec('tar', ['-xz', '-C', common.win2nix(parentDir), '-f', common.win2nix(downloadPath)])
     } else {
-      await exec.exec('tar', [ '-xz', '-C', parentDir, '-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) {

windows.js

@@ -36,18 +36,32 @@ export async function install(platform, engine, version) {
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  let rubyPrefix
-  if (common.shouldExtractInToolCache(engine, version)) {
-    rubyPrefix = common.getToolCacheRubyPrefix(platform, version)
+  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}`
   }
-  const parentDir = path.dirname(rubyPrefix)
 
   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)
@@ -60,7 +74,9 @@ export async function install(platform, engine, version) {
     await io.mv(path.join(parentDir, base), rubyPrefix)
   }
 
-  return rubyPrefix
+  if (common.shouldUseToolCache(engine, version)) {
+    common.createToolCacheCompleteFile(rubyPrefix)
+  }
 }
 
 async function setupMingw(version) {

yarn.lock

@@ -2,22 +2,22 @@
 # yarn lockfile v1
 
 
-"@actions/cache@^1.0.2":
-  version "1.0.2"
-  resolved "https://registry.yarnpkg.com/@actions/cache/-/cache-1.0.2.tgz#a223dcc752c7f988016d28ee7232f930f85cec61"
-  integrity sha512-CzAseaJ4cKmOI58EIWUb/LfeYdM7Y25s39OEMtWAhEPrPPzrbSEjGHCLaYjJ0V8C4iojo8vBYh5B3OIJ37EiJw==
+"@actions/cache@^1.0.5":
+  version "1.0.5"
+  resolved "https://registry.yarnpkg.com/@actions/cache/-/cache-1.0.5.tgz#ba98725d38611b5426fc57a2f00bd8b0d9202f36"
+  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.3", "@actions/core@^1.2.4", "@actions/core@^1.2.6":
+"@actions/core@^1.2.0", "@actions/core@^1.2.3", "@actions/core@^1.2.6":
   version "1.2.6"
   resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.2.6.tgz#a78d49f41a4def18e88ce47c2cac615d5694bf09"
   integrity sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==
@@ -44,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"