Allow running external function before 'bundle install'

External actions may use setup-ruby, and some actions make changes/additions to the build environment. These may be needed for dependencies.

Hence, allow those external actions to run code before 'bundle install'. This is done by passing a function as a parameter to setupRuby().

.github/workflows/test.yml

@@ -8,38 +8,45 @@ on:
     - '*'
     paths-ignore:
     - README.md
+  schedule:
+    - cron: '0 7 * * SUN'
 jobs:
   test:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu, macos, windows ]
+        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, ruby: rubinius }
+        - { os: ubuntu-18.04, ruby: rubinius }
-        - { os: windows, ruby: mingw }
+        - { os: windows-2016, ruby: mingw }
-        - { os: windows, ruby: mswin }
+        - { os: windows-2019, ruby: mingw }
+        - { os: windows-2019, ruby: mswin }
         exclude:
-        - { os: windows, ruby: debug }
+        - { os: windows-2016, ruby: debug }
-        - { os: windows, ruby: truffleruby }
+        - { os: windows-2016, ruby: truffleruby }
-        - { os: windows, ruby: truffleruby-head }
+        - { 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 }}-latest
+    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"
     - name: gcc and ridk version (mingw)
-      if: matrix.os == 'windows'
+      if: startsWith(matrix.os, 'windows')
       run: |
         $abi, $plat = $(ruby -e "STDOUT.write RbConfig::CONFIG['ruby_version'] + ' ' + RUBY_PLATFORM").split(' ')
         if ($plat.Contains('mingw')) {
@@ -65,10 +72,10 @@ jobs:
     - run: bundle exec rake --version
 
     - name: which ruby, rake
-      if: matrix.os != 'windows'
+      if: "!startsWith(matrix.os, 'windows')"
       run: which -a ruby rake
     - name: where ruby, rake
-      if: matrix.os == 'windows'
+      if: startsWith(matrix.os, 'windows')
       run: |
         $ErrorActionPreference = 'Continue'
         $where = 'ruby', 'rake'

README.md

@@ -33,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 |
+| Operating System | Recommended | Other Supported Versions |
-| ----------- | -------- |
+| ----------- | -------- | -------- |
-| Ubuntu  | `ubuntu-20.04`, `ubuntu-latest` (= `ubuntu-18.04`), `ubuntu-16.04` |
+| Ubuntu  | `ubuntu-latest`  (= `ubuntu-18.04`) | `ubuntu-20.04`, `ubuntu-16.04` |
-| macOS   | `macos-latest` |
+| macOS   | `macos-latest`   (= `macos-10.15`)  | |
-| Windows | `windows-latest` |
+| 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).
@@ -116,12 +116,31 @@ Otherwise, the latest Bundler version is installed (except for Ruby 2.2 and 2.3
 
 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') }}
@@ -140,7 +159,8 @@ 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

action.yml

@@ -13,6 +13,10 @@ inputs:
     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

common.js

@@ -1,5 +1,8 @@
 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')
 
@@ -20,6 +23,14 @@ 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') {
@@ -42,3 +53,12 @@ function findUbuntuVersion() {
     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,28 +3,33 @@ 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': '.',
 }
 
+// entry point when this action is run on its own
 export async function run() {
   try {
-    const options = {}
+    await setupRuby()
-    for (const key in inputDefaults) {
-      options[key] = core.getInput(key)
-    }
-    await setupRuby(options)
   } catch (error) {
     core.setFailed(error.message)
   }
 }
 
-export async function setupRuby(options) {
+// entry point when this action is run from other actions
-  const inputs = { ...inputDefaults, ...options }
+export async function setupRuby(options = {}) {
+  const inputs = { ...options }
+  for (const key in inputDefaults) {
+    if (!inputs.hasOwnProperty(key)) {
+      inputs[key] = core.getInput(key) || inputDefaults[key]
+    }
+  }
 
   process.chdir(inputs['working-directory'])
 
@@ -47,9 +52,21 @@ export async function setupRuby(options) {
 
   setupPath(newPathEntries)
 
+  // When setup-ruby is used by other actions, this allows code in them to run
+  // before 'bundle install'.  Installed dependencies may require additional
+  // libraries & headers, build tools, etc.
+  if (inputs['afterSetupPathHook'] instanceof Function) {
+    await inputs['afterSetupPathHook']({ platform, rubyPrefix, engine, version })
+  }
+
   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)
@@ -194,4 +211,81 @@ async function installBundler(bundlerVersionInput, platform, rubyPrefix, engine,
   }
 }
 
+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
+  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}`)
+      }
+    }
+  }
+}
+
+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

@@ -11,7 +11,7 @@ export function getVersions(platform) {
     ],
     "jruby": [
       "9.1.17.0",
-      "9.2.9.0", "9.2.10.0", "9.2.11.0", "9.2.11.1",
+      "9.2.9.0", "9.2.10.0", "9.2.11.0", "9.2.11.1", "9.2.12.0",
       "head"
     ],
     "truffleruby": [

ruby-builder.js

@@ -34,9 +34,15 @@ async function downloadAndExtract(platform, engine, version) {
     return await tc.downloadTool(url)
   })
 
-  const tar = platform.startsWith('windows') ? 'C:\\Windows\\system32\\tar.exe' : 'tar'
+  await common.measure('Extracting Ruby', async () => {
-  await common.measure('Extracting Ruby', async () =>
+    if (process.env.ImageOS === 'win16') {
-    exec.exec(tar, [ '-xz', '-C', rubiesDir, '-f',  downloadPath ]))
+      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, `${engine}-${version}`)
 }

yarn.lock

@@ -2,18 +2,44 @@
 # 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":
+"@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/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"
@@ -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==