Add a workflow to automatically bump the v1 branch when publishing a release

* So there isn't a giant try/catch around it.

.github/workflows/release.yml

@@ -0,0 +1,10 @@
+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
+    - run: git push origin HEAD:v1

.github/workflows/test.yml

@@ -3,19 +3,18 @@ on:
   pull_request:
   push:
     branches-ignore:
-    - master
     - v1
     tags-ignore:
     - '*'
     paths-ignore:
     - README.md
 jobs:
-  common:
+  test:
     strategy:
       fail-fast: false
       matrix:
         os: [ ubuntu, macos, windows ]
-        # Use various version syntaxes here for testing
+        # Use various version syntax 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 ]
         include:
         - { os: ubuntu, ruby: rubinius }
@@ -29,15 +28,17 @@ jobs:
     runs-on: ${{ matrix.os }}-latest
     steps:
     - uses: actions/checkout@v2
+
     - uses: ./
       with:
         ruby-version: ${{ matrix.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')
+      if: matrix.os == 'windows'
       run: |
         $abi, $plat = $(ruby -e "STDOUT.write RbConfig::CONFIG['ruby_version'] + ' ' + RUBY_PLATFORM").split(' ')
         if ($plat.Contains('mingw')) {
@@ -48,22 +49,25 @@ 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: matrix.os != 'windows'
       run: which -a ruby rake
     - name: where ruby, rake
-      if: startsWith(matrix.os, 'windows')
+      if: matrix.os == 'windows'
       run: |
         $ErrorActionPreference = 'Continue'
         $where = 'ruby', 'rake'

README.md

@@ -134,6 +134,11 @@ 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).
 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 +151,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.

action.yml

@@ -6,13 +6,17 @@ 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'
+  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'

dist/index.js

@@ -965,34 +965,42 @@ const common = __webpack_require__(239)
 
 async function run() {
   try {
-    const platform = common.getVirtualEnvironmentName()
-    const [engine, version] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
-
-    let installer
-    if (platform === 'windows-latest' && engine !== 'jruby') {
-      installer = __webpack_require__(826)
-    } else {
-      installer = __webpack_require__(489)
-    }
-
-    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 common.measure('Installing Bundler', async () =>
-      installBundler(platform, rubyPrefix, engine, version))
-
-    core.setOutput('ruby-prefix', rubyPrefix)
+    await main()
   } catch (error) {
     core.setFailed(error.message)
   }
 }
 
+async function main() {
+  process.chdir(core.getInput('working-directory'))
+
+  const platform = common.getVirtualEnvironmentName()
+  const [engine, version] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
+
+  let installer
+  if (platform === 'windows-latest' && engine !== 'jruby') {
+    installer = __webpack_require__(826)
+  } else {
+    installer = __webpack_require__(489)
+  }
+
+  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)
+
+  if (core.getInput('bundler') !== 'none') {
+    await common.measure('Installing Bundler', async () =>
+      installBundler(platform, rubyPrefix, engine, version))
+  }
+
+  core.setOutput('ruby-prefix', rubyPrefix)
+}
+
 function parseRubyEngineAndVersion(rubyVersion) {
   if (rubyVersion === 'default') {
     if (fs.existsSync('.ruby-version')) {
@@ -1093,9 +1101,6 @@ function readBundledWithFromGemfileLock() {
 
 async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
   var bundlerVersion = core.getInput('bundler')
-  if (bundlerVersion === 'none') {
-    return
-  }
 
   if (bundlerVersion === 'default' || bundlerVersion === 'Gemfile.lock') {
     bundlerVersion = readBundledWithFromGemfileLock()

index.js

@@ -7,34 +7,42 @@ const common = require('./common')
 
 export async function run() {
   try {
-    const platform = common.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 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 common.measure('Installing Bundler', async () =>
-      installBundler(platform, rubyPrefix, engine, version))
-
-    core.setOutput('ruby-prefix', rubyPrefix)
+    await main()
   } catch (error) {
     core.setFailed(error.message)
   }
 }
 
+async function main() {
+  process.chdir(core.getInput('working-directory'))
+
+  const platform = common.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 engineVersions = installer.getAvailableVersions(platform, engine)
+  const ruby = validateRubyEngineAndVersion(platform, engineVersions, engine, version)
+
+  createGemRC()
+
+  const [rubyPrefix, newPathEntries] = await installer.install(platform, ruby)
+
+  setupPath(ruby, newPathEntries)
+
+  if (core.getInput('bundler') !== 'none') {
+    await common.measure('Installing Bundler', async () =>
+      installBundler(platform, rubyPrefix, engine, version))
+  }
+
+  core.setOutput('ruby-prefix', rubyPrefix)
+}
+
 function parseRubyEngineAndVersion(rubyVersion) {
   if (rubyVersion === 'default') {
     if (fs.existsSync('.ruby-version')) {
@@ -135,9 +143,6 @@ function readBundledWithFromGemfileLock() {
 
 async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
   var bundlerVersion = core.getInput('bundler')
-  if (bundlerVersion === 'none') {
-    return
-  }
 
   if (bundlerVersion === 'default' || bundlerVersion === 'Gemfile.lock') {
     bundlerVersion = readBundledWithFromGemfileLock()