Fixup bundler version for rubies with bundler as a default gem

Fixes #117

.github/workflows/test.yml

@@ -17,20 +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-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: '3.0' }
         - { os: windows-2016, ruby: debug }
         - { os: windows-2016, ruby: truffleruby }
         - { os: windows-2016, ruby: truffleruby-head }
+        - { 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 }}
@@ -102,7 +103,7 @@ jobs:
       run: gem install sassc -N
 
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
     - uses: actions/checkout@v2
     - run: yarn install

README.md

@@ -16,7 +16,7 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
 | ----------- | -------- |
 | 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 |
+| 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`).
 
@@ -170,6 +186,7 @@ This action might work with [self-hosted runners](https://docs.github.com/en/act
 if the [virtual environment](https://github.com/actions/virtual-environments) is very similar to the ones used by GitHub runners. Notably:
 
 * Make sure to use the same operating system and version.
+* Set the environment variable `ImageOS` to the corresponding value on GitHub-hosted runners (e.g. `ubuntu18`/`macos1015`/`win19`). This is necessary to detect the operating system and version.
 * Make sure to use the same version of libssl.
 * Make sure that the operating system has `libyaml-0` installed
 * The default tool cache directory (`/opt/hostedtoolcache` on Linux, `/Users/runner/hostedtoolcache` on macOS,

common.js

@@ -11,6 +11,14 @@ 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)]
+}
+
 export async function measure(name, block) {
   return await core.group(name, async () => {
     const start = performance.now()
@@ -28,6 +36,10 @@ export function isHeadVersion(rubyVersion) {
   return rubyVersion === 'head' || rubyVersion === 'debug' || rubyVersion === 'mingw' || rubyVersion === 'mswin'
 }
 
+export function isStableVersion(rubyVersion) {
+  return /^\d+(\.\d+)*$/.test(rubyVersion)
+}
+
 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')
@@ -91,7 +103,7 @@ export function getToolCacheRubyPrefix(platform, version) {
 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, '\\ ')
 }

dist/index.js

@@ -27796,7 +27796,7 @@ 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)
   })
 
@@ -32094,8 +32094,10 @@ exports.default = _default;
 __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "windows", function() { return windows; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "drive", function() { return drive; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "partition", function() { return partition; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "measure", function() { return measure; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isHeadVersion", function() { return isHeadVersion; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isStableVersion", function() { return isStableVersion; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "hashFile", function() { return hashFile; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "getVirtualEnvironmentName", function() { return getVirtualEnvironmentName; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "shouldExtractInToolCache", function() { return shouldExtractInToolCache; });
@@ -32115,6 +32117,14 @@ const windows = (os.platform() === 'win32')
 // Extract to SSD on Windows, see https://github.com/ruby/setup-ruby/pull/14
 const drive = (windows ? (process.env['GITHUB_WORKSPACE'] || 'C')[0] : undefined)
 
+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)]
+}
+
 async function measure(name, block) {
   return await core.group(name, async () => {
     const start = performance.now()
@@ -32132,6 +32142,10 @@ function isHeadVersion(rubyVersion) {
   return rubyVersion === 'head' || rubyVersion === 'debug' || rubyVersion === 'mingw' || rubyVersion === 'mswin'
 }
 
+function isStableVersion(rubyVersion) {
+  return /^\d+(\.\d+)*$/.test(rubyVersion)
+}
+
 async function hashFile(file) {
   // See https://github.com/actions/runner/blob/master/src/Misc/expressionFunc/hashFiles/src/hashFiles.ts
   const hash = crypto.createHash('sha256')
@@ -32195,7 +32209,7 @@ function getToolCacheRubyPrefix(platform, version) {
 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, '\\ ')
 }
@@ -44536,7 +44550,7 @@ function getVersions(platform) {
     ],
     "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"
     ]
   }
@@ -51264,7 +51278,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`)
   }
 
@@ -51276,7 +51290,7 @@ function parseRubyEngineAndVersion(rubyVersion) {
     engine = rubyVersion
     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]
@@ -51290,7 +51304,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.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 {
@@ -51382,6 +51402,8 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     const gem = path.join(rubyPrefix, 'bin', 'gem')
     await exec.exec(gem, ['install', 'bundler', '-v', `~> ${bundlerVersion}`, '--no-document'])
   }
+
+  core.exportVariable('BUNDLER_VERSION', bundlerVersion)
 }
 
 async function bundleInstall(gemfile, lockFile, platform, engine, version) {
@@ -51407,7 +51429,7 @@ async function bundleInstall(gemfile, lockFile, platform, engine, version) {
   const paths = [path]
   const baseKey = await computeBaseKey(platform, engine, version, 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}`)
 
@@ -51432,6 +51454,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 {

index.js

@@ -106,7 +106,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`)
   }
 
@@ -118,7 +118,7 @@ function parseRubyEngineAndVersion(rubyVersion) {
     engine = rubyVersion
     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]
@@ -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.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 {
@@ -224,6 +230,8 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     const gem = path.join(rubyPrefix, 'bin', 'gem')
     await exec.exec(gem, ['install', 'bundler', '-v', `~> ${bundlerVersion}`, '--no-document'])
   }
+
+  core.exportVariable('BUNDLER_VERSION', bundlerVersion)
 }
 
 async function bundleInstall(gemfile, lockFile, platform, engine, version) {
@@ -249,7 +257,7 @@ async function bundleInstall(gemfile, lockFile, platform, engine, version) {
   const paths = [path]
   const baseKey = await computeBaseKey(platform, engine, version, 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 +282,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 {

ruby-builder-versions.js

@@ -18,7 +18,7 @@ export function getVersions(platform) {
     ],
     "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"
     ]
   }

windows.js

@@ -120,7 +120,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)
   })