Detect self-hosted runners not matching a GitHub-hosted runner image

* And give instructions for that case.
* Get the OS and OS version ourselves since some users set ImageOS incorrectly.
* This partially reverts commit ad1ebae995.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -3,7 +3,12 @@ description: Create a report to help us improve
 body:
 - type: markdown
   attributes:
-    value: Please note we will close your issue without comment if you do not fill out the requested information.
+    value: |
+      First, take some time to think whether this is really an issue of ruby/setup-ruby and whether it is fixable in this action.
+      This action basically just downloads a prebuilt Ruby and adds it to `PATH`, so it is unlikely the bug is in this action.
+      Give some thoughts whether it could be an issue in your workflow, in the gems you use, in GitHub Actions, in Ruby, RubyGems, Bundler, etc.
+      This is NOT the place to ask help about your workflow failing (ask that on [GitHub Community](https://github.com/orgs/community/discussions/categories/actions) or [Discussions](https://github.com/ruby/setup-ruby/discussions) instead), it is only to report issues about ruby/setup-ruby.
+      Please note we will close your issue without comment if you do not fill out the requested information.
 - type: checkboxes
   attributes:
     label: Ensure the following before filing this issue

.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-18.04, ubuntu-20.04, ubuntu-22.04, macos-10.15, macos-11, macos-12, windows-2019, windows-2022 ]
+        os: [ ubuntu-20.04, ubuntu-22.04, macos-11, macos-12, windows-2019, windows-2022 ]
         ruby: [
           '1.9', '2.0', '2.1', '2.2', '2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2', ruby-head,
           jruby, jruby-head,

README.md

@@ -42,8 +42,8 @@ The action works on these [GitHub-hosted runners](https://docs.github.com/en/act
 
 | Operating System | Supported |
 | ---------------- | --------- |
-| Ubuntu  | `ubuntu-18.04`, `ubuntu-20.04`, `ubuntu-22.04` |
-| macOS   | `macos-10.15`, `macos-11`, `macos-12` |
+| Ubuntu  | `ubuntu-20.04`, `ubuntu-22.04` |
+| macOS   | `macos-11`, `macos-12` |
 | Windows | `windows-2019`, `windows-2022` |
 
 The prebuilt releases are generated by [ruby-builder](https://github.com/ruby/ruby-builder)
@@ -252,7 +252,6 @@ This action might work with [self-hosted runners](https://docs.github.com/en/act
 if the [Runner Image](https://github.com/actions/runner-images) is very similar to the ones used by GitHub runners. Notably:
 
 * Make sure to use the same operating system and version.
-* Set the environment variable `ImageOS` on the runner to the corresponding value on GitHub-hosted runners (e.g. `ubuntu18`/`macos1015`/`win19`). This is necessary to detect the operating system and version.
 * Make sure to use the same version of libssl.
 * Make sure that the operating system has `libyaml-0` and [`libgmp`](https://stackoverflow.com/questions/26555902/ruby-v-dyld-library-not-loaded-usr-local-lib-libgmp-10-dylib) installed
 * The default tool cache directory (`/opt/hostedtoolcache` on Linux, `/Users/runner/hostedtoolcache` on macOS,
@@ -260,9 +259,9 @@ if the [Runner Image](https://github.com/actions/runner-images) is very similar
   This is necessary since the Ruby builds embed the install path when built and cannot be moved around.
 * `/home/runner` must be writable by the `runner` user.
 
-In other cases, please use a system Ruby or [install Ruby manually](https://github.com/postmodern/chruby/wiki#installing-rubies) instead.
-
-On a self-hosted runner you need to define the `ImageOs` as an evironment variable on the host, you can do this in the `~/actions-runner/.env` file (See [#230](https://github.com/ruby/setup-ruby/issues/230)).
+In other cases, you will need to install Ruby in the runner tool cache as shown by the action when it detects that case
+(run it so it will show you where to install Ruby).
+You could of course also not use this action and e.g. use Ruby from a system package or use a Docker image instead.
 
 ## History
 

bundler.js

@@ -232,8 +232,14 @@ export async function bundleInstall(gemfile, lockFile, platform, engine, rubyVer
 }
 
 async function computeBaseKey(platform, engine, version, lockFile, cacheVersion) {
-  const cacheVersionSuffix = DEFAULT_CACHE_VERSION === cacheVersion ? '' : `-cachever:${cacheVersion}`
-  let key = `setup-ruby-bundler-cache-v4-${platform}-${engine}-${version}${cacheVersionSuffix}`
+  const cwd = process.cwd()
+  const bundleWith = process.env['BUNDLE_WITH'] || ''
+  const bundleWithout = process.env['BUNDLE_WITHOUT'] || ''
+  let key = `setup-ruby-bundler-cache-v5-${common.getOSNameVersionArch()}-${engine}-${version}-wd-${cwd}-with-${bundleWith}-without-${bundleWithout}`
+
+  if (cacheVersion !== DEFAULT_CACHE_VERSION) {
+    key += `-v-${cacheVersion}`
+  }
 
   if (common.isHeadVersion(version)) {
     if (engine !== 'jruby') {

common.js

@@ -6,6 +6,8 @@ const stream = require('stream')
 const crypto = require('crypto')
 const core = require('@actions/core')
 const { performance } = require('perf_hooks')
+const linuxOSInfo = require('linux-os-info')
+import macosRelease from 'macos-release'
 
 export const windows = (os.platform() === 'win32')
 // Extract to SSD on Windows, see https://github.com/ruby/setup-ruby/pull/14
@@ -151,55 +153,74 @@ export async function hashFile(file) {
   return hash.digest('hex')
 }
 
-function getImageOS() {
-  const imageOS = process.env['ImageOS']
-  if (!imageOS) {
-    throw new Error('The environment variable ImageOS must be set')
-  }
-  return imageOS
-}
-
-export const supportedPlatforms = [
-  'ubuntu-18.04',
-  'ubuntu-20.04',
-  'ubuntu-22.04',
-  'macos-10.15',
-  'macos-11',
-  'macos-12',
-  'windows-2019',
-  'windows-2022',
+const GitHubHostedPlatforms = [
+  'ubuntu-20.04-x64',
+  'ubuntu-22.04-x64',
+  'macos-11-x64',
+  'macos-12-x64',
+  'windows-2019-x64',
+  'windows-2022-x64',
 ]
 
+// Actually a self-hosted runner which does not correspond to a GitHub-hosted runner image
+export function isSelfHostedRunner() {
+  return !GitHubHostedPlatforms.includes(getOSNameVersionArch())
+}
+
+let virtualEnvironmentName = undefined
+
 export function getVirtualEnvironmentName() {
-  const imageOS = getImageOS()
-
-  let match = imageOS.match(/^ubuntu(\d+)/) // e.g. ubuntu18
-  if (match) {
-    return `ubuntu-${match[1]}.04`
+  if (virtualEnvironmentName !== undefined) {
+    return virtualEnvironmentName
   }
 
-  match = imageOS.match(/^macos(\d{2})(\d+)?/) // e.g. macos1015, macos11
-  if (match) {
-    if (match[2]) {
-      return `macos-${match[1]}.${match[2]}`
-    } else {
-      return `macos-${match[1]}`
-    }
+  const platform = os.platform()
+  let osName
+  let osVersion
+  if (platform === 'linux') {
+    const info = linuxOSInfo({mode: 'sync'})
+    osName = info.id
+    osVersion = info.version_id
+  } else if (platform === 'darwin') {
+    osName = 'macos'
+    osVersion = macosRelease().version
+  } else if (platform === 'win32') {
+    osName = 'windows'
+    osVersion = findWindowsVersion()
+  } else {
+    throw new Error(`Unknown platform ${platform}`)
   }
 
-  match = imageOS.match(/^win(\d+)/) // e.g. win19
-  if (match) {
-    return `windows-20${match[1]}`
-  }
+  virtualEnvironmentName = `${osName}-${osVersion}`
+  return virtualEnvironmentName
+}
 
-  throw new Error(`Unknown ImageOS ${imageOS}`)
+export function getOSNameVersionArch() {
+  return `${getVirtualEnvironmentName()}-${os.arch()}`
+}
+
+function findWindowsVersion() {
+  const version = os.version();
+  const match = version.match(/^Windows Server (\d+) Datacenter/)
+  if (match) {
+    return match[1]
+  } else {
+    throw new Error('Could not find Windows version')
+  }
 }
 
 export function shouldUseToolCache(engine, version) {
-  return engine === 'ruby' && !isHeadVersion(version)
+  return (engine === 'ruby' && !isHeadVersion(version)) || isSelfHostedRunner()
 }
 
 function getPlatformToolCache(platform) {
+  if (isSelfHostedRunner()) {
+    const runnerToolCache = process.env['RUNNER_TOOL_CACHE']
+    if (!runnerToolCache) {
+      throw new Error('$RUNNER_TOOL_CACHE must be set on self-hosted runners')
+    }
+    return runnerToolCache
+  }
   // Hardcode paths rather than using $RUNNER_TOOL_CACHE because the prebuilt Rubies cannot be moved anyway
   if (platform.startsWith('ubuntu-')) {
     return '/opt/hostedtoolcache'
@@ -212,14 +233,23 @@ function getPlatformToolCache(platform) {
   }
 }
 
-export function getToolCacheRubyPrefix(platform, version) {
+export function getToolCacheRubyPrefix(platform, engine, version) {
   const toolCache = getPlatformToolCache(platform)
-  return path.join(toolCache, 'Ruby', version, 'x64')
+  const name = {
+    ruby: 'Ruby',
+    jruby: 'JRuby',
+    truffleruby: 'TruffleRuby',
+    "truffleruby+graalvm": 'TruffleRubyGraalVM'
+  }[engine]
+  return path.join(toolCache, name, version, os.arch())
+}
+
+export function toolCacheCompleteFile(toolCacheRubyPrefix) {
+  return `${toolCacheRubyPrefix}.complete`
 }
 
 export function createToolCacheCompleteFile(toolCacheRubyPrefix) {
-  const completeFile = `${toolCacheRubyPrefix}.complete`
-  fs.writeFileSync(completeFile, '')
+  fs.writeFileSync(toolCacheCompleteFile(toolCacheRubyPrefix), '')
 }
 
 // convert windows path like C:\Users\runneradmin to /c/Users/runneradmin

index.js

@@ -46,7 +46,7 @@ export async function setupRuby(options = {}) {
   const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
 
   let installer
-  if (platform.startsWith('windows-') && engine === 'ruby') {
+  if (platform.startsWith('windows-') && engine === 'ruby' && !common.isSelfHostedRunner()) {
     installer = require('./windows')
   } else {
     installer = require('./ruby-builder')
@@ -60,7 +60,7 @@ export async function setupRuby(options = {}) {
 
   // JRuby can use compiled extension code, so make sure gcc exists.
   // As of Jan-2022, JRuby compiles against msvcrt.
-  if (platform.startsWith('windows') && (engine === 'jruby') && 
+  if (platform.startsWith('windows') && engine === 'jruby' &&
     !fs.existsSync('C:\\msys64\\mingw64\\bin\\gcc.exe')) {
     await require('./windows').installJRubyTools()
   }

package.json

@@ -27,6 +27,8 @@
     "@actions/exec": "^1.1.1",
     "@actions/io": "^1.1.2",
     "@actions/tool-cache": "^2",
+    "linux-os-info": "^2.0.0",
+    "macos-release": "^3.1.0",
     "semver": "^7.3.7"
   },
   "devDependencies": {

ruby-builder.js

@@ -1,6 +1,7 @@
 const os = require('os')
 const fs = require('fs')
 const path = require('path')
+const core = require('@actions/core')
 const exec = require('@actions/exec')
 const io = require('@actions/io')
 const tc = require('@actions/tool-cache')
@@ -13,10 +14,6 @@ const releasesURL = 'https://github.com/ruby/ruby-builder/releases'
 const windows = common.windows
 
 export function getAvailableVersions(platform, engine) {
-  if (!common.supportedPlatforms.includes(platform)) {
-    throw new Error(`Unsupported platform ${platform}`)
-  }
-
   return rubyBuilderVersions[engine]
 }
 
@@ -27,7 +24,21 @@ export async function install(platform, engine, version) {
     if (inToolCache) {
       rubyPrefix = inToolCache
     } else {
-      rubyPrefix = common.getToolCacheRubyPrefix(platform, version)
+      const toolCacheRubyPrefix = common.getToolCacheRubyPrefix(platform, engine, version)
+      if (common.isSelfHostedRunner()) {
+        const rubyBuildDefinition = engine === 'ruby' ? version : `${engine}-${version}`
+        core.error(
+          `The current runner (${common.getOSNameVersionArch()}) was detected as self-hosted and not matching a GitHub-hosted runner image.\n` +
+          `In such a case, you should install Ruby in the $RUNNER_TOOL_CACHE yourself, for example using https://github.com/rbenv/ruby-build:\n` +
+          `You can take inspiration from this workflow for more details: https://github.com/ruby/ruby-builder/blob/master/.github/workflows/build.yml\n` +
+          `$ ruby-build ${rubyBuildDefinition} ${toolCacheRubyPrefix}\n` +
+          `Once that completes successfully, mark it as complete with:\n` +
+          `$ touch ${common.toolCacheCompleteFile(toolCacheRubyPrefix)}\n` +
+          `It is your responsibility to ensure installing Ruby like that is not done in parallel.\n`)
+        process.exit(1)
+      } else {
+        rubyPrefix = toolCacheRubyPrefix
+      }
     }
   } else if (windows) {
     rubyPrefix = path.join(`${common.drive}:`, `${engine}-${version}`)

windows-versions.json

@@ -52,6 +52,7 @@
   "3.1.2": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.1.2-1/rubyinstaller-3.1.2-1-x64.7z",
   "3.1.3": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.1.3-1/rubyinstaller-3.1.3-1-x64.7z",
   "3.2.0": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.0-1/rubyinstaller-3.2.0-1-x64.7z",
+  "3.2.1": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.1-1/rubyinstaller-3.2.1-1-x64.7z",
   "head": "https://github.com/oneclick/rubyinstaller2/releases/download/rubyinstaller-head/rubyinstaller-head-x64.7z",
   "mingw": "https://github.com/MSP-Greg/ruby-loco/releases/download/ruby-master/ruby-mingw.7z",
   "mswin": "https://github.com/MSP-Greg/ruby-loco/releases/download/ruby-master/ruby-mswin.7z",

windows.js

@@ -27,13 +27,7 @@ const certFile = 'C:\\Program Files\\Git\\mingw64\\ssl\\cert.pem'
 const msys1 = `${drive}:\\DevKit64`
 const msysPathEntries = [`${msys1}\\mingw\\x86_64-w64-mingw32\\bin`, `${msys1}\\mingw\\bin`, `${msys1}\\bin`]
 
-const virtualEnv = common.getVirtualEnvironmentName()
-
 export function getAvailableVersions(platform, engine) {
-  if (!common.supportedPlatforms.includes(platform)) {
-    throw new Error(`Unsupported platform ${platform}`)
-  }
-
   if (engine === 'ruby') {
     return Object.keys(rubyInstallerVersions)
   } else {
@@ -46,7 +40,7 @@ export async function install(platform, engine, version) {
 
   // The windows-2016 and windows-2019 images have MSYS2 build tools (C:/msys64/usr)
   // and MinGW build tools installed.  The windows-2022 image has neither.
-  const hasMSYS2PreInstalled = ['windows-2019', 'windows-2016'].includes(virtualEnv)
+  const hasMSYS2PreInstalled = ['windows-2019', 'windows-2016'].includes(platform)
 
   if (!url.endsWith('.7z')) {
     throw new Error(`URL should end in .7z: ${url}`)
@@ -59,7 +53,7 @@ export async function install(platform, engine, version) {
     if (inToolCache) {
       rubyPrefix = inToolCache
     } else {
-      rubyPrefix = common.getToolCacheRubyPrefix(platform, version)
+      rubyPrefix = common.getToolCacheRubyPrefix(platform, engine, version)
     }
   } else {
     rubyPrefix = `${drive}:\\${base}`

yarn.lock

@@ -283,6 +283,11 @@ ip-regex@^2.1.0:
   resolved "https://registry.yarnpkg.com/ip-regex/-/ip-regex-2.1.0.tgz#fa78bf5d2e6913c911ce9f819ee5146bb6d844e9"
   integrity sha512-58yWmlHpp7VYfcdTwMTvwMmqx/Elfxjd9RXTDyMsbL7lLWmhMylLEqiYVLKuLzOZqVgiWXD9MfR62Vv89VRxkw==
 
+linux-os-info@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/linux-os-info/-/linux-os-info-2.0.0.tgz#32a251077c13af1a69dbcb36a168901208e32776"
+  integrity sha512-ZopyH4kT2Ehnmix8iUgS/41pfv7fSlUV1JukIn3DB3qD3byvhBNtgCbUApoAtiqcHRLKXCY3zakXlJgiExm2Qg==
+
 lru-cache@^6.0.0:
   version "6.0.0"
   resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94"
@@ -290,6 +295,11 @@ lru-cache@^6.0.0:
   dependencies:
     yallist "^4.0.0"
 
+macos-release@^3.1.0:
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/macos-release/-/macos-release-3.1.0.tgz#6165bb0736ae567ed6649e36ce6a24d87cbb7aca"
+  integrity sha512-/M/R0gCDgM+Cv1IuBG1XGdfTFnMEG6PZeT+KGWHO/OG+imqmaD9CH5vHBTycEM3+Kc4uG2Il+tFAuUWLqQOeUA==
+
 mime-db@1.52.0:
   version "1.52.0"
   resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70"