Add notes about Windows in the README

* It already ran on the feature branch.

.github/workflows/test.yml

@@ -2,6 +2,7 @@ name: Test this action
 on:
   push:
     branches-ignore:
+    - master
     - v1
     tags-ignore:
     - '*'
@@ -14,7 +15,7 @@ jobs:
       matrix:
         os: [ ubuntu-16.04, ubuntu-18.04, macos-latest, windows-latest ]
         # Use various version syntaxes here for testing
-        ruby: [ .ruby-version, 2.3, 2.7.0, ruby-head, jruby, truffleruby, truffleruby-head, rubinius ]
+        ruby: [ .ruby-version, 2.2, 2.3, 2.7.0, ruby-head, jruby, truffleruby, truffleruby-head, rubinius ]
         exclude:
         - os: windows-latest
           ruby: truffleruby
@@ -34,7 +35,7 @@ jobs:
         ruby-version: ${{ matrix.ruby }}
     - run: ruby --version
     - run: ridk version
-      if: matrix.os == 'windows-latest' && !startsWith(matrix.ruby, '2.3')
+      if: matrix.os == 'windows-latest' && !startsWith(matrix.ruby, 'jruby') && !startsWith(matrix.ruby, '2.3') && !startsWith(matrix.ruby, '2.2')
     - name: Subprocess test
       run: ruby test_subprocess.rb
     - name: OpenSSL version

README.md

@@ -1,24 +1,30 @@
-# use-ruby-action
+# setup-ruby
+
+Note: this action used to be at `eregon/use-ruby-action` and was moved to the `ruby` organization.
 
 This action downloads a prebuilt ruby and adds it to the `PATH`.
 
 It is very efficient and takes about 5 seconds to download, extract and add the given Ruby to the `PATH`.
 No extra packages need to be installed.
 
+Compared to [actions/setup-ruby](https://github.com/actions/setup-ruby),
+this actions supports many more versions and features.
+
 ### Supported Versions
 
 This action currently supports these versions of MRI, JRuby and TruffleRuby:
 
 | Interpreter | Versions |
 | ----------- | -------- |
-| Ruby | 2.3.0 - 2.3.8, 2.4.0 - 2.4.9, 2.5.0 - 2.5.7, 2.6.0 - 2.6.5, 2.7.0, head |
+| Ruby | 2.2, 2.3.0 - 2.3.8, 2.4.0 - 2.4.9, 2.5.0 - 2.5.7, 2.6.0 - 2.6.5, 2.7.0, head |
 | JRuby | 9.2.9.0 |
 | TruffleRuby | 19.3.0, 19.3.1, head |
 | Rubinius | 4.14 |
 
-Note that Ruby 2.3 and the OpenSSL version it needs (1.0.2) are both end-of-life,
-which means Ruby 2.3 is unmaintained and considered insecure.
+Note that Ruby ≤ 2.3 and the OpenSSL version it needs (1.0.2) are both end-of-life,
+which means Ruby ≤ 2.3 is unmaintained and considered insecure.
 On Windows, Ruby 2.4 uses OpenSSL 1.0.2, which is no longer maintained.
+Ruby 2.2 resolves to 2.2.6 on Windows (last build from RubyInstaller) and 2.2.10 otherwise.
 
 ### Supported Platforms
 
@@ -32,9 +38,9 @@ The action works for all [GitHub-hosted runners](https://help.github.com/en/acti
 
 Rubinius is only available on `ubuntu-latest`.
 
-The prebuilt releases are generated by [ruby-builder](https://github.com/eregon/ruby-builder)
+The prebuilt releases are generated by [ruby-builder](https://github.com/ruby/ruby-builder)
 and on Windows by [RubyInstaller2](https://github.com/oneclick/rubyinstaller2).
-`ruby-head` is generated by [ruby-dev-builder](https://github.com/eregon/ruby-dev-builder) and `truffleruby-head` is generated by [truffleruby-dev-builder](https://github.com/eregon/truffleruby-dev-builder).
+`ruby-head` is generated by [ruby-dev-builder](https://github.com/ruby/ruby-dev-builder) and `truffleruby-head` is generated by [truffleruby-dev-builder](https://github.com/ruby/truffleruby-dev-builder).
 The full list of available Ruby versions can be seen in [ruby-builder-versions.js](ruby-builder-versions.js)
 for Ubuntu and macOS and in [windows-versions.js](windows-versions.js) for Windows.
 
@@ -50,7 +56,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: eregon/use-ruby-action@v1
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.6
     - run: ruby -v
@@ -73,7 +79,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
-    - uses: eregon/use-ruby-action@v1
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - run: ruby -v
@@ -117,6 +123,17 @@ 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.
 
+## Windows
+
+Note that running CI on Windows can be quite challenging if you are not very familiar with Windows.
+It is recommended to first get your build working on Ubuntu and macOS before trying Windows.
+
+* The default shell on Windows is not Bash but [PowerShell](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell).
+  This can lead issues such as multi-line scripts [not working as expected](https://github.com/ruby/setup-ruby/issues/13).
+* The `PATH` contains [multiple compiler toolchains](https://github.com/ruby/setup-ruby/issues/19). Use `where` to debug which tool is used.
+* MSYS2 is prepended to the `PATH`, similar to what RubyInstaller2 does.
+* 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.
@@ -128,5 +145,6 @@ This follows the [recommendations](https://github.com/actions/toolkit/blob/maste
 
 ## Credits
 
+The current maintainer of this action is @eregon.
 Most of the Windows logic is from https://github.com/MSP-Greg/actions-ruby by MSP-Greg.
 Many thanks to MSP-Greg and Lars Kanis for the help with Ruby Installer.

dist/index.js

@@ -1448,7 +1448,7 @@ function validateRubyEngineAndVersion(platform, engineVersions, engine, version)
     } else {
       throw new Error(`Unknown version ${version} for ${engine} on ${platform}
         available versions for ${engine} on ${platform}: ${engineVersions.join(', ')}
-        File an issue at https://github.com/eregon/use-ruby-action/issues if would like support for a new version`)
+        File an issue at https://github.com/ruby/setup-ruby/issues if would like support for a new version`)
     }
   }
 
@@ -2145,6 +2145,7 @@ __webpack_require__.r(__webpack_exports__);
 function getVersions(platform) {
   const versions = {
     "ruby": [
+      "2.2.10",
       "2.3.0", "2.3.1", "2.3.2", "2.3.3", "2.3.4", "2.3.5", "2.3.6", "2.3.7", "2.3.8",
       "2.4.0", "2.4.1", "2.4.2", "2.4.3", "2.4.4", "2.4.5", "2.4.6", "2.4.7", "2.4.9",
       "2.5.0", "2.5.1", "2.5.2", "2.5.3", "2.5.4", "2.5.5", "2.5.6", "2.5.7",
@@ -5103,6 +5104,7 @@ exports.getState = getState;
 __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "versions", function() { return versions; });
 const versions = {
+  "2.2.6": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.2.6-x64-mingw32.7z",
   "2.3.0": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.3.0-x64-mingw32.7z",
   "2.3.1": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.3.1-x64-mingw32.7z",
   "2.3.3": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.3.3-x64-mingw32.7z",
@@ -5149,7 +5151,7 @@ const rubyBuilderVersions = __webpack_require__(156)
 const axios = __webpack_require__(53)
 
 const builderReleaseTag = 'builds-no-warn'
-const releasesURL = 'https://github.com/eregon/ruby-builder/releases'
+const releasesURL = 'https://github.com/ruby/ruby-builder/releases'
 
 function getAvailableVersions(platform, engine) {
   return rubyBuilderVersions.getVersions(platform)[engine]
@@ -5158,9 +5160,13 @@ function getAvailableVersions(platform, engine) {
 async function install(platform, ruby) {
   const rubyPrefix = await downloadAndExtract(platform, ruby)
 
-  core.addPath(path.join(rubyPrefix, 'bin'))
-  if (ruby.startsWith('rubinius')) {
-    core.addPath(path.join(rubyPrefix, 'gems', 'bin'))
+  if (platform === 'windows-latest') {
+    __webpack_require__(826).setupPath(undefined, rubyPrefix)
+  } else {
+    core.addPath(path.join(rubyPrefix, 'bin'))
+    if (ruby.startsWith('rubinius')) {
+      core.addPath(path.join(rubyPrefix, 'gems', 'bin'))
+    }
   }
 
   return rubyPrefix
@@ -5189,7 +5195,7 @@ async function getDownloadURL(platform, ruby) {
 
 async function getLatestHeadBuildURL(platform, ruby) {
   const engine = ruby.split('-')[0]
-  const repository = `eregon/${engine}-dev-builder`
+  const repository = `ruby/${engine}-dev-builder`
   const metadataURL = `https://raw.githubusercontent.com/${repository}/metadata/latest_build.tag`
   const releasesURL = `https://github.com/${repository}/releases/download`
 
@@ -7858,6 +7864,7 @@ module.exports = function mergeConfig(config1, config2) {
 __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "getAvailableVersions", function() { return getAvailableVersions; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "install", function() { return install; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "setupPath", function() { return setupPath; });
 // Most of this logic is from
 // https://github.com/MSP-Greg/actions-ruby/blob/master/lib/main.js
 
@@ -7885,18 +7892,17 @@ async function install(platform, ruby) {
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  // Extract to SSD, see https://github.com/eregon/use-ruby-action/pull/14
+  // Extract to SSD, see https://github.com/ruby/setup-ruby/pull/14
   const drive = (process.env['GITHUB_WORKSPACE'] || 'C')[0]
 
   const downloadPath = await tc.downloadTool(url)
-  await exec.exec(`7z x ${downloadPath} -xr!${base}\\share\\doc -o${drive}:\\`)
+  await exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${drive}:\\`], { silent: true })
   const rubyPrefix = `${drive}:\\${base}`
 
   const [hostedRuby, msys2] = await linkMSYS2()
-  const newPath = setupPath(msys2, rubyPrefix)
-  core.exportVariable('PATH', newPath)
+  setupPath(msys2, rubyPrefix)
 
-  if (version.startsWith('2.3')) {
+  if (version.startsWith('2.2') || version.startsWith('2.3')) {
     core.exportVariable('SSL_CERT_FILE', `${hostedRuby}\\ssl\\cert.pem`)
   }
 
@@ -7923,21 +7929,29 @@ async function linkMSYS2() {
 }
 
 function setupPath(msys2, rubyPrefix) {
-  let path = process.env['PATH'].split(';')
-
-  // Remove conflicting dev tools from PATH
-  path = path.filter(e => !e.match(/\b(Chocolatey|CMake|mingw64|OpenSSL|Strawberry)\b/))
+  const originalPath = process.env['PATH'].split(';')
+  let path = originalPath.slice()
 
   // Remove default Ruby in PATH
   path = path.filter(e => !e.match(/\bRuby\b/))
 
-  // Add MSYS2 in PATH
-  path.unshift(`${msys2}\\mingw64\\bin`, `${msys2}\\usr\\bin`)
+  if (msys2) {
+    // Add MSYS2 in PATH
+    path.unshift(`${msys2}\\mingw64\\bin`, `${msys2}\\usr\\bin`)
+  }
 
   // Add the downloaded Ruby in PATH
   path.unshift(`${rubyPrefix}\\bin`)
 
-  return path.join(';')
+  console.log("Entries removed from PATH to avoid conflicts with Ruby:")
+  for (const entry of originalPath) {
+    if (!path.includes(entry)) {
+      console.log(entry)
+    }
+  }
+
+  const newPath = path.join(';')
+  core.exportVariable('PATH', newPath)
 }
 
 

generate-windows-versions.rb

@@ -2,6 +2,7 @@ require 'net/http'
 require 'yaml'
 require 'json'
 
+min_version = '2.2.6'
 url = 'https://raw.githubusercontent.com/oneclick/rubyinstaller.org-website/master/_data/downloads.yaml'
 entries = YAML.load(Net::HTTP.get(URI(url)), symbolize_names: true)
 
@@ -18,7 +19,7 @@ versions = entries.select { |entry|
 }.sort_by { |version, entry|
   version
 }.select { |version, entry|
-  version >= "2.3"
+  Gem::Version.new(version) >= Gem::Version.new(min_version)
 }.map { |version, entry|
   [version, entry[:href]]
 }.to_h

index.js

@@ -57,7 +57,7 @@ function validateRubyEngineAndVersion(platform, engineVersions, engine, version)
     } else {
       throw new Error(`Unknown version ${version} for ${engine} on ${platform}
         available versions for ${engine} on ${platform}: ${engineVersions.join(', ')}
-        File an issue at https://github.com/eregon/use-ruby-action/issues if would like support for a new version`)
+        File an issue at https://github.com/ruby/setup-ruby/issues if would like support for a new version`)
     }
   }
 

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "use-ruby-action",
+  "name": "setup-ruby",
   "version": "0.1.0",
   "description": "Download a prebuilt Ruby and add it to the PATH in 5 seconds",
   "main": "index.js",
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/eregon/use-ruby-action.git"
+    "url": "git+https://github.com/ruby/setup-ruby.git"
   },
   "keywords": [
     "GitHub",
@@ -19,9 +19,9 @@
   "author": "Benoit Daloze",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/eregon/use-ruby-action/issues"
+    "url": "https://github.com/ruby/setup-ruby/issues"
   },
-  "homepage": "https://github.com/eregon/use-ruby-action",
+  "homepage": "https://github.com/ruby/setup-ruby",
   "dependencies": {
     "@actions/core": "^1.1.1",
     "@actions/exec": "^1.0.1",

ruby-builder-versions.js

@@ -1,6 +1,7 @@
 export function getVersions(platform) {
   const versions = {
     "ruby": [
+      "2.2.10",
       "2.3.0", "2.3.1", "2.3.2", "2.3.3", "2.3.4", "2.3.5", "2.3.6", "2.3.7", "2.3.8",
       "2.4.0", "2.4.1", "2.4.2", "2.4.3", "2.4.4", "2.4.5", "2.4.6", "2.4.7", "2.4.9",
       "2.5.0", "2.5.1", "2.5.2", "2.5.3", "2.5.4", "2.5.5", "2.5.6", "2.5.7",

ruby-builder.js

@@ -7,7 +7,7 @@ const rubyBuilderVersions = require('./ruby-builder-versions')
 const axios = require('axios')
 
 const builderReleaseTag = 'builds-no-warn'
-const releasesURL = 'https://github.com/eregon/ruby-builder/releases'
+const releasesURL = 'https://github.com/ruby/ruby-builder/releases'
 
 export function getAvailableVersions(platform, engine) {
   return rubyBuilderVersions.getVersions(platform)[engine]
@@ -16,9 +16,13 @@ export function getAvailableVersions(platform, engine) {
 export async function install(platform, ruby) {
   const rubyPrefix = await downloadAndExtract(platform, ruby)
 
-  core.addPath(path.join(rubyPrefix, 'bin'))
-  if (ruby.startsWith('rubinius')) {
-    core.addPath(path.join(rubyPrefix, 'gems', 'bin'))
+  if (platform === 'windows-latest') {
+    require('./windows').setupPath(undefined, rubyPrefix)
+  } else {
+    core.addPath(path.join(rubyPrefix, 'bin'))
+    if (ruby.startsWith('rubinius')) {
+      core.addPath(path.join(rubyPrefix, 'gems', 'bin'))
+    }
   }
 
   return rubyPrefix
@@ -47,7 +51,7 @@ async function getDownloadURL(platform, ruby) {
 
 async function getLatestHeadBuildURL(platform, ruby) {
   const engine = ruby.split('-')[0]
-  const repository = `eregon/${engine}-dev-builder`
+  const repository = `ruby/${engine}-dev-builder`
   const metadataURL = `https://raw.githubusercontent.com/${repository}/metadata/latest_build.tag`
   const releasesURL = `https://github.com/${repository}/releases/download`
 

windows-versions.js

@@ -1,4 +1,5 @@
 export const versions = {
+  "2.2.6": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.2.6-x64-mingw32.7z",
   "2.3.0": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.3.0-x64-mingw32.7z",
   "2.3.1": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.3.1-x64-mingw32.7z",
   "2.3.3": "https://dl.bintray.com/oneclick/rubyinstaller/ruby-2.3.3-x64-mingw32.7z",

windows.js

@@ -25,18 +25,17 @@ export async function install(platform, ruby) {
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  // Extract to SSD, see https://github.com/eregon/use-ruby-action/pull/14
+  // Extract to SSD, see https://github.com/ruby/setup-ruby/pull/14
   const drive = (process.env['GITHUB_WORKSPACE'] || 'C')[0]
 
   const downloadPath = await tc.downloadTool(url)
-  await exec.exec(`7z x ${downloadPath} -xr!${base}\\share\\doc -o${drive}:\\`)
+  await exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${drive}:\\`], { silent: true })
   const rubyPrefix = `${drive}:\\${base}`
 
   const [hostedRuby, msys2] = await linkMSYS2()
-  const newPath = setupPath(msys2, rubyPrefix)
-  core.exportVariable('PATH', newPath)
+  setupPath(msys2, rubyPrefix)
 
-  if (version.startsWith('2.3')) {
+  if (version.startsWith('2.2') || version.startsWith('2.3')) {
     core.exportVariable('SSL_CERT_FILE', `${hostedRuby}\\ssl\\cert.pem`)
   }
 
@@ -62,20 +61,28 @@ async function linkMSYS2() {
   return [latestHostedRuby, msys2]
 }
 
-function setupPath(msys2, rubyPrefix) {
-  let path = process.env['PATH'].split(';')
-
-  // Remove conflicting dev tools from PATH
-  path = path.filter(e => !e.match(/\b(Chocolatey|CMake|mingw64|OpenSSL|Strawberry)\b/))
+export function setupPath(msys2, rubyPrefix) {
+  const originalPath = process.env['PATH'].split(';')
+  let path = originalPath.slice()
 
   // Remove default Ruby in PATH
   path = path.filter(e => !e.match(/\bRuby\b/))
 
-  // Add MSYS2 in PATH
-  path.unshift(`${msys2}\\mingw64\\bin`, `${msys2}\\usr\\bin`)
+  if (msys2) {
+    // Add MSYS2 in PATH
+    path.unshift(`${msys2}\\mingw64\\bin`, `${msys2}\\usr\\bin`)
+  }
 
   // Add the downloaded Ruby in PATH
   path.unshift(`${rubyPrefix}\\bin`)
 
-  return path.join(';')
+  console.log("Entries removed from PATH to avoid conflicts with Ruby:")
+  for (const entry of originalPath) {
+    if (!path.includes(entry)) {
+      console.log(entry)
+    }
+  }
+
+  const newPath = path.join(';')
+  core.exportVariable('PATH', newPath)
 }