Add an exported setupRuby() function which can be called from other actions

* Inputs are passed as simple object properties.
* It is recommended to expose the same inputs for other actions.
* See #58 and #33.

.github/workflows/test.yml

@@ -15,13 +15,13 @@ jobs:
       matrix:
         os: [ ubuntu, macos, windows ]
         # Use various version syntax here for testing
-        ruby: [ 2.2, 2.3, 2.4, 2.5, 2.6.6, 2.7, ruby-head, ruby-debug, jruby-9.1, jruby, jruby-head, truffleruby, truffleruby-head ]
+        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: windows, ruby: mingw }
         - { os: windows, ruby: mswin }
         exclude:
-        - { os: windows, ruby: ruby-debug }
+        - { os: windows, ruby: debug }
         - { os: windows, ruby: truffleruby }
         - { os: windows, ruby: truffleruby-head }
 

README.md

@@ -64,13 +64,14 @@ jobs:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        ruby-version: 2.6 # Not needed with a .ruby-version file
-    - run: ruby -v
+    - 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
@@ -80,17 +81,23 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest, macos-latest ]
+        os: [ubuntu, macos]
-        ruby: [ 2.4, 2.5, 2.6, 2.7, jruby, truffleruby ]
+        ruby: [2.5, 2.6, 2.7, head, debug, jruby, jruby-head, truffleruby, truffleruby-head]
-    runs-on: ${{ matrix.os }}
+    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`
@@ -105,7 +112,7 @@ 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.
 
@@ -122,8 +129,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.  

dist/index.js

@@ -969,6 +969,7 @@ module.exports = require("os");
 "use strict";
 __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "run", function() { return run; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "setupRuby", function() { return setupRuby; });
 const os = __webpack_require__(87)
 const fs = __webpack_require__(747)
 const path = __webpack_require__(622)
@@ -976,19 +977,31 @@ const core = __webpack_require__(470)
 const exec = __webpack_require__(986)
 const common = __webpack_require__(239)
 
+const inputDefaults = {
+  'ruby-version': 'default',
+  'bundler': 'default',
+  'working-directory': '.',
+}
+
 async function run() {
   try {
-    await main()
+    const options = {}
+    for (const key in inputDefaults) {
+      options[key] = core.getInput(key)
+    }
+    await setupRuby(options)
   } catch (error) {
     core.setFailed(error.message)
   }
 }
 
-async function main() {
+async function setupRuby(options) {
-  process.chdir(core.getInput('working-directory'))
+  const inputs = { ...inputDefaults, ...options }
+
+  process.chdir(inputs['working-directory'])
 
   const platform = common.getVirtualEnvironmentName()
-  const [engine, parsedVersion] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
+  const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
 
   let installer
   if (platform === 'windows-latest' && engine !== 'jruby') {
@@ -1006,9 +1019,9 @@ async function main() {
 
   setupPath(newPathEntries)
 
-  if (core.getInput('bundler') !== 'none') {
+  if (inputs['bundler'] !== 'none') {
     await common.measure('Installing Bundler', async () =>
-      installBundler(platform, rubyPrefix, engine, version))
+      installBundler(inputs['bundler'], platform, rubyPrefix, engine, version))
   }
 
   core.setOutput('ruby-prefix', rubyPrefix)
@@ -1036,7 +1049,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
@@ -1057,7 +1070,7 @@ function validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVe
   let version = parsedVersion
   if (!engineVersions.includes(parsedVersion)) {
     const latestToFirstVersion = engineVersions.slice().reverse()
-    const found = latestToFirstVersion.find(v => v !== 'head' && v.startsWith(parsedVersion))
+    const found = latestToFirstVersion.find(v => !common.isHeadVersion(v) && v.startsWith(parsedVersion))
     if (found) {
       version = found
     } else {
@@ -1113,8 +1126,8 @@ function readBundledWithFromGemfileLock() {
   return null
 }
 
-async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
+async function installBundler(bundlerVersionInput, platform, rubyPrefix, engine, rubyVersion) {
-  var bundlerVersion = core.getInput('bundler')
+  var bundlerVersion = bundlerVersionInput
 
   if (bundlerVersion === 'default' || bundlerVersion === 'Gemfile.lock') {
     bundlerVersion = readBundledWithFromGemfileLock()
@@ -1127,15 +1140,20 @@ async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
     bundlerVersion = '2'
   }
 
-  if (rubyVersion.startsWith('2.2')) {
+  if (/^\d+/.test(bundlerVersion)) {
-    console.log('Bundler 2 requires Ruby 2.3+, using Bundler 1 on Ruby 2.2')
-    bundlerVersion = '1'
-  } else if (/^\d+/.test(bundlerVersion)) {
     // OK
   } else {
     throw new Error(`Cannot parse bundler input: ${bundlerVersion}`)
   }
 
+  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') {

index.js

@@ -5,19 +5,31 @@ const core = require('@actions/core')
 const exec = require('@actions/exec')
 const common = require('./common')
 
+const inputDefaults = {
+  'ruby-version': 'default',
+  'bundler': 'default',
+  'working-directory': '.',
+}
+
 export async function run() {
   try {
-    await main()
+    const options = {}
+    for (const key in inputDefaults) {
+      options[key] = core.getInput(key)
+    }
+    await setupRuby(options)
   } catch (error) {
     core.setFailed(error.message)
   }
 }
 
-async function main() {
+export async function setupRuby(options) {
-  process.chdir(core.getInput('working-directory'))
+  const inputs = { ...inputDefaults, ...options }
+
+  process.chdir(inputs['working-directory'])
 
   const platform = common.getVirtualEnvironmentName()
-  const [engine, parsedVersion] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
+  const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
 
   let installer
   if (platform === 'windows-latest' && engine !== 'jruby') {
@@ -35,9 +47,9 @@ async function main() {
 
   setupPath(newPathEntries)
 
-  if (core.getInput('bundler') !== 'none') {
+  if (inputs['bundler'] !== 'none') {
     await common.measure('Installing Bundler', async () =>
-      installBundler(platform, rubyPrefix, engine, version))
+      installBundler(inputs['bundler'], platform, rubyPrefix, engine, version))
   }
 
   core.setOutput('ruby-prefix', rubyPrefix)
@@ -65,7 +77,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
@@ -86,7 +98,7 @@ function validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVe
   let version = parsedVersion
   if (!engineVersions.includes(parsedVersion)) {
     const latestToFirstVersion = engineVersions.slice().reverse()
-    const found = latestToFirstVersion.find(v => v !== 'head' && v.startsWith(parsedVersion))
+    const found = latestToFirstVersion.find(v => !common.isHeadVersion(v) && v.startsWith(parsedVersion))
     if (found) {
       version = found
     } else {
@@ -142,8 +154,8 @@ function readBundledWithFromGemfileLock() {
   return null
 }
 
-async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
+async function installBundler(bundlerVersionInput, platform, rubyPrefix, engine, rubyVersion) {
-  var bundlerVersion = core.getInput('bundler')
+  var bundlerVersion = bundlerVersionInput
 
   if (bundlerVersion === 'default' || bundlerVersion === 'Gemfile.lock') {
     bundlerVersion = readBundledWithFromGemfileLock()
@@ -156,15 +168,20 @@ async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
     bundlerVersion = '2'
   }
 
-  if (rubyVersion.startsWith('2.2')) {
+  if (/^\d+/.test(bundlerVersion)) {
-    console.log('Bundler 2 requires Ruby 2.3+, using Bundler 1 on Ruby 2.2')
-    bundlerVersion = '1'
-  } else if (/^\d+/.test(bundlerVersion)) {
     // OK
   } else {
     throw new Error(`Cannot parse bundler input: ${bundlerVersion}`)
   }
 
+  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') {