Automatically create a ~/.gemrc file

* To avoid generating documentation on `gem install`, which can take a long time.

.github/workflows/test.yml

@@ -33,14 +33,17 @@ jobs:
     - name: build compiler
       run: |
         ruby -e "puts 'build compiler: ' + RbConfig::CONFIG.fetch('CC_VERSION_MESSAGE', 'unknown').lines.first"
-    - name: ridk version (mingw)
+    - name: gcc and ridk version (mingw)
       if: startsWith(matrix.os, 'windows')
       run: |
         $abi, $plat = $(ruby -e "STDOUT.write RbConfig::CONFIG['ruby_version'] + ' ' + RUBY_PLATFORM").split(' ')
-        if (($abi -ge '2.4') -and $plat.Contains('mingw')) {
-          ridk version
-        } else {
-          echo 'ridk is unavailable'
+        if ($plat.Contains('mingw')) {
+          gcc --version
+          if ($abi -ge '2.4') {
+            ridk version
+          } else {
+            echo 'ridk is unavailable'
+          }
         }
     - name: Subprocess test
       run: ruby test_subprocess.rb
@@ -87,14 +90,17 @@ jobs:
     - name: build compiler
       run: |
         ruby -e "puts 'build compiler: ' + RbConfig::CONFIG.fetch('CC_VERSION_MESSAGE', 'unknown').lines.first"
-    - name: ridk version (mingw)
-      if: startsWith(matrix.cfg.os, 'windows')
+    - name: gcc and ridk version (mingw)
+      if: startsWith(matrix.os, 'windows')
       run: |
         $abi, $plat = $(ruby -e "STDOUT.write RbConfig::CONFIG['ruby_version'] + ' ' + RUBY_PLATFORM").split(' ')
-        if (($abi -ge '2.4') -and $plat.Contains('mingw')) {
-          ridk version
-        } else {
-          echo 'ridk is unavailable'
+        if ($plat.Contains('mingw')) {
+          gcc --version
+          if ($abi -ge '2.4') {
+            ridk version
+          } else {
+            echo 'ridk is unavailable'
+          }
         }
     - name: Subprocess test
       run: ruby test_subprocess.rb

README.md

@@ -22,11 +22,14 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
 | TruffleRuby | 19.3.0 - 20.0.0, head |
 | Rubinius | 4.14 |
 
-On Windows, `mingw` and `mswin` are `ruby-head` builds using the MSYS2/MinGW and the MSVC toolchains respectively.  
+On Windows, `mingw` and `mswin` are `ruby-head` builds using the MSYS2/MinGW and the MSVC toolchains respectively.
+
+Ruby 2.2 resolves to 2.2.6 on Windows (last build from RubyInstaller) and 2.2.10 otherwise.  
+Ruby 2.3 on Windows only has builds for 2.3.0, 2.3.1 and 2.3.3 (same as RubyInstaller).
+
 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
 
@@ -140,7 +143,8 @@ It is recommended to first get your build working on Ubuntu and macOS before try
 * 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.exe` to debug which tool is used.
-* MSYS2 is prepended to the `PATH`, similar to what RubyInstaller2 does.
+* For Ruby ≥ 2.4, MSYS2 is prepended to the `Path`, similar to what RubyInstaller2 does.
+* 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

dist/index.js

@@ -951,8 +951,11 @@ module.exports = require("os");
 /***/ }),
 
 /***/ 104:
-/***/ (function(__unusedmodule, __unusedexports, __webpack_require__) {
+/***/ (function(__unusedmodule, __webpack_exports__, __webpack_require__) {
 
+"use strict";
+__webpack_require__.r(__webpack_exports__);
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "run", function() { return run; });
 const os = __webpack_require__(87)
 const fs = __webpack_require__(747)
 const path = __webpack_require__(622)
@@ -973,6 +976,8 @@ async function run() {
     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)
@@ -1037,6 +1042,13 @@ function validateRubyEngineAndVersion(platform, engineVersions, engine, version)
   return engine + '-' + version
 }
 
+function createGemRC() {
+  const gemrc = path.join(os.homedir(), '.gemrc')
+  if (!fs.existsSync(gemrc)) {
+    fs.writeFileSync(gemrc, `gem: --no-document${os.EOL}`)
+  }
+}
+
 function setupPath(ruby, newPathEntries) {
     const originalPath = process.env['PATH'].split(path.delimiter)
     let cleanPath = originalPath.filter(entry => !/\bruby\b/i.test(entry))
@@ -1076,7 +1088,7 @@ function findUbuntuVersion() {
   }
 }
 
-run()
+if (__filename.endsWith('index.js')) { run() }
 
 
 /***/ }),
@@ -3412,7 +3424,7 @@ function getAvailableVersions(platform, engine) {
 
 async function install(platform, ruby) {
   const rubyPrefix = await downloadAndExtract(platform, ruby)
-  let newPathEntries;
+  let newPathEntries
   if (ruby.startsWith('rubinius')) {
     newPathEntries = [path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')]
   } else {
@@ -4798,19 +4810,28 @@ __webpack_require__.r(__webpack_exports__);
 // https://github.com/MSP-Greg/actions-ruby/blob/master/lib/main.js
 
 const fs = __webpack_require__(747)
+const path = __webpack_require__(622)
 const cp = __webpack_require__(129)
 const core = __webpack_require__(470)
 const exec = __webpack_require__(986)
 const tc = __webpack_require__(533)
 const rubyInstallerVersions = __webpack_require__(471).versions
 
+// Extract to SSD, see https://github.com/ruby/setup-ruby/pull/14
+const drive = (process.env['GITHUB_WORKSPACE'] || 'C')[0]
+
 // needed for 2.2, 2.3, and mswin, cert file used by Git for Windows
 const certFile = 'C:\\Program Files\\Git\\mingw64\\ssl\\cert.pem'
 
-// standard MSYS2 location, found by 'devkit'
+// standard MSYS2 location, found by 'devkit.rb'
 const msys2 = 'C:\\msys64'
 const msys2PathEntries = [`${msys2}\\mingw64\\bin`, `${msys2}\\usr\\bin`]
 
+// location & path for old RubyInstaller DevKit (MSYS), Ruby 2.2 and 2.3
+const msys = `${drive}:\\DevKit64`
+const msysPathEntries = [`${msys}\\mingw\\x86_64-w64-mingw32\\bin`,
+  `${msys}\\mingw\\bin`, `${msys}\\bin`]
+
 function getAvailableVersions(platform, engine) {
   if (engine === 'ruby') {
     return Object.keys(rubyInstallerVersions)
@@ -4829,9 +4850,6 @@ async function install(platform, ruby) {
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  // 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}:\\`], { silent: true })
   const rubyPrefix = `${drive}:\\${base}`
@@ -4863,14 +4881,31 @@ async function symLinkToEmbeddedMSYS2() {
 async function setupMingw(version) {
   if (version.startsWith('2.2') || version.startsWith('2.3')) {
     core.exportVariable('SSL_CERT_FILE', certFile)
-  }
+    await installMSYS(version)
 
-  // Remove when Actions Windows image contains MSYS2 install
-  if (!fs.existsSync(msys2)) {
-    await symLinkToEmbeddedMSYS2()
-  }
+    return msysPathEntries
+  } else {
+    // Remove when Actions Windows image contains MSYS2 install
+    if (!fs.existsSync(msys2)) {
+      await symLinkToEmbeddedMSYS2()
+    }
 
-  return msys2PathEntries
+    return msys2PathEntries
+  }
+}
+
+// Ruby 2.2 and 2.3
+async function installMSYS(version) {
+  const url = 'https://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe'
+  const downloadPath = await tc.downloadTool(url)
+  await exec.exec('7z', ['x', downloadPath, `-o${msys}`], { silent: true })
+
+  // below are set in the old devkit.rb file ?
+  core.exportVariable('RI_DEVKIT', msys)
+  core.exportVariable('CC' , 'gcc')
+  core.exportVariable('CXX', 'g++')
+  core.exportVariable('CPP', 'cpp')
+  core.info(`Installed RubyInstaller DevKit for Ruby ${version}`)
 }
 
 async function setupMSWin() {
@@ -4915,7 +4950,7 @@ function addVCVARSEnv() {
   for (let [k, v] of newEnv) {
     if (process.env[k] !== v) {
       if (k === 'Path') {
-        newPathEntries = v.replace(process.env['Path'], '').split(';')
+        newPathEntries = v.replace(process.env['Path'], '').split(path.delimiter)
       } else {
         core.exportVariable(k, v)
       }

index.js

@@ -3,7 +3,7 @@ const fs = require('fs')
 const path = require('path')
 const core = require('@actions/core')
 
-async function run() {
+export async function run() {
   try {
     const platform = getVirtualEnvironmentName()
     const [engine, version] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
@@ -18,6 +18,8 @@ async function run() {
     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)
@@ -82,6 +84,13 @@ function validateRubyEngineAndVersion(platform, engineVersions, engine, version)
   return engine + '-' + version
 }
 
+function createGemRC() {
+  const gemrc = path.join(os.homedir(), '.gemrc')
+  if (!fs.existsSync(gemrc)) {
+    fs.writeFileSync(gemrc, `gem: --no-document${os.EOL}`)
+  }
+}
+
 function setupPath(ruby, newPathEntries) {
     const originalPath = process.env['PATH'].split(path.delimiter)
     let cleanPath = originalPath.filter(entry => !/\bruby\b/i.test(entry))
@@ -121,4 +130,4 @@ function findUbuntuVersion() {
   }
 }
 
-run()
+if (__filename.endsWith('index.js')) { run() }

ruby-builder.js

@@ -14,7 +14,7 @@ export function getAvailableVersions(platform, engine) {
 
 export async function install(platform, ruby) {
   const rubyPrefix = await downloadAndExtract(platform, ruby)
-  let newPathEntries;
+  let newPathEntries
   if (ruby.startsWith('rubinius')) {
     newPathEntries = [path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')]
   } else {

windows.js

@@ -2,19 +2,28 @@
 // https://github.com/MSP-Greg/actions-ruby/blob/master/lib/main.js
 
 const fs = require('fs')
+const path = require('path')
 const cp = require('child_process')
 const core = require('@actions/core')
 const exec = require('@actions/exec')
 const tc = require('@actions/tool-cache')
 const rubyInstallerVersions = require('./windows-versions').versions
 
+// Extract to SSD, see https://github.com/ruby/setup-ruby/pull/14
+const drive = (process.env['GITHUB_WORKSPACE'] || 'C')[0]
+
 // needed for 2.2, 2.3, and mswin, cert file used by Git for Windows
 const certFile = 'C:\\Program Files\\Git\\mingw64\\ssl\\cert.pem'
 
-// standard MSYS2 location, found by 'devkit'
+// standard MSYS2 location, found by 'devkit.rb'
 const msys2 = 'C:\\msys64'
 const msys2PathEntries = [`${msys2}\\mingw64\\bin`, `${msys2}\\usr\\bin`]
 
+// location & path for old RubyInstaller DevKit (MSYS), Ruby 2.2 and 2.3
+const msys = `${drive}:\\DevKit64`
+const msysPathEntries = [`${msys}\\mingw\\x86_64-w64-mingw32\\bin`,
+  `${msys}\\mingw\\bin`, `${msys}\\bin`]
+
 export function getAvailableVersions(platform, engine) {
   if (engine === 'ruby') {
     return Object.keys(rubyInstallerVersions)
@@ -33,9 +42,6 @@ export async function install(platform, ruby) {
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  // 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}:\\`], { silent: true })
   const rubyPrefix = `${drive}:\\${base}`
@@ -67,14 +73,31 @@ async function symLinkToEmbeddedMSYS2() {
 async function setupMingw(version) {
   if (version.startsWith('2.2') || version.startsWith('2.3')) {
     core.exportVariable('SSL_CERT_FILE', certFile)
-  }
+    await installMSYS(version)
 
-  // Remove when Actions Windows image contains MSYS2 install
-  if (!fs.existsSync(msys2)) {
-    await symLinkToEmbeddedMSYS2()
-  }
+    return msysPathEntries
+  } else {
+    // Remove when Actions Windows image contains MSYS2 install
+    if (!fs.existsSync(msys2)) {
+      await symLinkToEmbeddedMSYS2()
+    }
 
-  return msys2PathEntries
+    return msys2PathEntries
+  }
+}
+
+// Ruby 2.2 and 2.3
+async function installMSYS(version) {
+  const url = 'https://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe'
+  const downloadPath = await tc.downloadTool(url)
+  await exec.exec('7z', ['x', downloadPath, `-o${msys}`], { silent: true })
+
+  // below are set in the old devkit.rb file ?
+  core.exportVariable('RI_DEVKIT', msys)
+  core.exportVariable('CC' , 'gcc')
+  core.exportVariable('CXX', 'g++')
+  core.exportVariable('CPP', 'cpp')
+  core.info(`Installed RubyInstaller DevKit for Ruby ${version}`)
 }
 
 async function setupMSWin() {
@@ -119,7 +142,7 @@ export function addVCVARSEnv() {
   for (let [k, v] of newEnv) {
     if (process.env[k] !== v) {
       if (k === 'Path') {
-        newPathEntries = v.replace(process.env['Path'], '').split(';')
+        newPathEntries = v.replace(process.env['Path'], '').split(path.delimiter)
       } else {
         core.exportVariable(k, v)
       }