Shorten job title to fit in GH UI

* See https://github.com/ruby/setup-ruby/issues/543

.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-20.04, ubuntu-22.04, macos-11, macos-12, macos-13, windows-2019, windows-2022 ]
+        os: [ ubuntu-20.04, ubuntu-22.04, macos-11, macos-12, macos-13, macos-arm-oss, 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', '3.3', ruby-head,
           jruby, jruby-head,
@@ -31,7 +31,17 @@ jobs:
         - { os: windows-2022, ruby: mswin }
         - { os: windows-2022, ruby: ucrt  }
         exclude:
-        - { os: ubuntu-22.04, ruby: '2.2' } # https://github.com/ruby/setup-ruby/issues/496
+        # https://github.com/ruby/setup-ruby/issues/496
+        - { os: ubuntu-22.04, ruby: '2.2' }
+        # Too old, fails to compile on macos-arm-oss
+        - { os: macos-arm-oss, ruby: '1.9' }
+        - { os: macos-arm-oss, ruby: '2.0' }
+        - { os: macos-arm-oss, ruby: '2.1' }
+        - { os: macos-arm-oss, ruby: '2.2' }
+        - { os: macos-arm-oss, ruby: '2.3' }
+        - { os: macos-arm-oss, ruby: '2.4' }
+        - { os: macos-arm-oss, ruby: '2.5' }
+        # Windows
         - { os: windows-2019, ruby: '1.9' }
         - { os: windows-2019, ruby: '3.3' }
         - { os: windows-2019, ruby: debug }
@@ -159,15 +169,26 @@ jobs:
       - run: ruby -v
 
   testLatestRubygemsVersion:
-    name: "Test rubygems: latest upgrades the default RubyGems version"
+    name: "Test rubygems: latest on ${{ matrix.ruby }}"
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - { ruby: '3.2', expected_rubygems_version: '3.5.3'  }
+        - { ruby: '3.0', expected_rubygems_version: '3.5.3'  }
+        - { ruby: '2.7', expected_rubygems_version: '3.4.22' }
+        - { ruby: '2.6', expected_rubygems_version: '3.4.22' }
+        - { ruby: '2.5', expected_rubygems_version: '3.3.27' }
+        - { ruby: '2.3', expected_rubygems_version: '3.3.27' }
+        - { ruby: '2.0', expected_rubygems_version: '2.7.11' }
     steps:
     - uses: actions/checkout@v4
     - uses: ./
       with:
-        ruby-version: '2.6'
+        ruby-version: ${{ matrix.ruby }}
         rubygems: latest
-    - run: ruby -e "exit(Gem.rubygems_version > Gem::Version.new('3.0.3'))"
+    - run: ruby -e 'puts Gem::VERSION; exit(Gem.rubygems_version >= Gem::Version.new("${{ matrix.expected_rubygems_version }}"))'
 
   testFixedRubygemsVersionUpgrades:
     name: "Test rubygems: version upgrades RubyGems to that version if the default is older"

README.md

@@ -15,10 +15,10 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
 
 | Interpreter | Versions |
 | ----------- | -------- |
-| `ruby` | 1.9.3, 2.0.0, 2.1.9, 2.2, all versions from 2.3.0 until 3.3.0-preview2, head, debug, mingw, mswin, ucrt |
-| `jruby` | 9.1.17.0 - 9.4.3.0, head |
-| `truffleruby` | 19.3.0 - 23.1.0, head |
-| `truffleruby+graalvm` | 21.2.0 - 23.1.0, head |
+| `ruby` | 1.9.3, 2.0.0, 2.1.9, 2.2, all versions from 2.3.0 until 3.3.0, head, debug, mingw, mswin, ucrt |
+| `jruby` | 9.1.17.0 - 9.4.5.0, head |
+| `truffleruby` | 19.3.0 - 23.1.1, head |
+| `truffleruby+graalvm` | 21.2.0 - 23.1.1, head |
 
 `ruby-debug` is the same as `ruby-head` but with assertions enabled (`-DRUBY_DEBUG=1`).  
 
@@ -43,7 +43,7 @@ The action works on these [GitHub-hosted runners](https://docs.github.com/en/act
 | Operating System | Supported |
 | ---------------- | --------- |
 | Ubuntu  | `ubuntu-20.04`, `ubuntu-22.04` |
-| macOS   | `macos-11`, `macos-12`, `macos-13` |
+| macOS   | `macos-11`, `macos-12`, `macos-13`, `macos-13-xlarge` (arm64) |
 | Windows | `windows-2019`, `windows-2022` |
 
 The prebuilt releases are generated by [ruby-builder](https://github.com/ruby/ruby-builder)
@@ -70,7 +70,7 @@ jobs:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3.2' # Not needed with a .ruby-version file
+        ruby-version: '3.3' # Not needed with a .ruby-version file
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - run: bundle exec rake
 ```
@@ -89,7 +89,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: ['2.7', '3.0', '3.1', '3.2', head, jruby, jruby-head, truffleruby, truffleruby-head]
+        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3', head, jruby, jruby-head, truffleruby, truffleruby-head]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
@@ -118,7 +118,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.2'
+          ruby-version: '3.3'
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - run: bundle exec rake
 ```
@@ -263,6 +263,9 @@ In other cases, you will need to install Ruby in the runner tool cache as shown
 (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.
 
+See also the [`self-hosted:` input](action.yml).
+You can set it to `true` if you want to use custom-built Rubies in your self-hosted toolcache instead of prebuild Rubies.
+
 ## History
 
 This action used to be at `eregon/use-ruby-action` and was moved to the `ruby` organization.

action.yml

@@ -12,7 +12,8 @@ inputs:
     description: |
       The version of RubyGems to use. Either 'default' (the default), 'latest', or a version number (e.g., 3.3.5).
       For 'default', no action is taken and the version of RubyGems that comes with Ruby by default is used.
-      For 'latest', `gem update --system` is run to update to the latest RubyGems version.
+      For 'latest', `gem update --system` is run to update to the latest compatible RubyGems version.
+      Ruby head/master builds will not be updated.
       Similarly, if a version number is given, `gem update --system <version>` is run to update to that version of RubyGems, as long as that version is newer than the one provided by default.
   bundler:
     description: |
@@ -34,10 +35,10 @@ inputs:
     description: |
       Consider the runner as a self-hosted runner, which means not using prebuilt Ruby binaries which only work
       on GitHub-hosted runners or self-hosted runners with a very similar image to the ones used by GitHub runners.
-      The default is to detect this automatically based on the OS, OS version and $RUNNER_TOOL_CACHE.
+      The default is to detect this automatically based on the OS, OS version and architecture.
 outputs:
   ruby-prefix:
     description: 'The prefix of the installed ruby'
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'

common.js

@@ -168,11 +168,12 @@ const GitHubHostedPlatforms = [
   'macos-11-x64',
   'macos-12-x64',
   'macos-13-x64',
+  'macos-13-arm64',
   'windows-2019-x64',
   'windows-2022-x64',
 ]
 
-// Actually a self-hosted runner for which  the OS and OS version does not correspond to a GitHub-hosted runner image,
+// Actually a self-hosted runner for which the OS and OS version does not correspond to a GitHub-hosted runner image,
 export function isSelfHostedRunner() {
   if (inputs.selfHosted === undefined) {
     throw new Error('inputs.selfHosted should have been already set')
@@ -192,11 +193,11 @@ export function selfHostedRunnerReason() {
   }
 }
 
-let virtualEnvironmentName = undefined
+let osNameVersion = undefined
 
-export function getVirtualEnvironmentName() {
-  if (virtualEnvironmentName !== undefined) {
-    return virtualEnvironmentName
+export function getOSNameVersion() {
+  if (osNameVersion !== undefined) {
+    return osNameVersion
   }
 
   const platform = os.platform()
@@ -216,12 +217,12 @@ export function getVirtualEnvironmentName() {
     throw new Error(`Unknown platform ${platform}`)
   }
 
-  virtualEnvironmentName = `${osName}-${osVersion}`
-  return virtualEnvironmentName
+  osNameVersion = `${osName}-${osVersion}`
+  return osNameVersion
 }
 
 export function getOSNameVersionArch() {
-  return `${getVirtualEnvironmentName()}-${os.arch()}`
+  return `${getOSNameVersion()}-${os.arch()}`
 }
 
 function findWindowsVersion() {
@@ -243,7 +244,7 @@ export function getToolCachePath() {
     return getRunnerToolCache()
   } else {
     // Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE
-    // so use that path is not isSelfHostedRunner()
+    // so use that path if not isSelfHostedRunner()
     return getDefaultToolCachePath()
   }
 }
@@ -258,7 +259,7 @@ export function getRunnerToolCache() {
 
 // Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE
 function getDefaultToolCachePath() {
-  const platform = getVirtualEnvironmentName()
+  const platform = getOSNameVersion()
   if (platform.startsWith('ubuntu-')) {
     return '/opt/hostedtoolcache'
   } else if (platform.startsWith('macos-')) {

index.js

@@ -30,6 +30,9 @@ export async function run() {
       core.setFailed(error.stack)
     }
   }
+  // Explicit process.exit() to not wait hanging promises,
+  // see https://github.com/ruby/setup-ruby/issues/543
+  process.exit()
 }
 
 // entry point when this action is run from other actions
@@ -44,7 +47,7 @@ export async function setupRuby(options = {}) {
 
   process.chdir(inputs['working-directory'])
 
-  const platform = common.getVirtualEnvironmentName()
+  const platform = common.getOSNameVersion()
   const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
 
   let installer
@@ -75,7 +78,7 @@ export async function setupRuby(options = {}) {
   const rubygemsInputSet = inputs['rubygems'] !== 'default'
   if (rubygemsInputSet) {
     await common.measure('Updating RubyGems', async () =>
-      rubygems.rubygemsUpdate(inputs['rubygems'], rubyPrefix))
+      rubygems.rubygemsUpdate(inputs['rubygems'], rubyPrefix, platform, engine, version))
   }
 
   // When setup-ruby is used by other actions, this allows code in them to run

ruby-builder-versions.json

@@ -12,14 +12,14 @@
     "3.0.0-preview1", "3.0.0-preview2", "3.0.0-rc1", "3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4", "3.0.5", "3.0.6",
     "3.1.0-preview1", "3.1.0", "3.1.1", "3.1.2", "3.1.3", "3.1.4",
     "3.2.0-preview1", "3.2.0-preview2", "3.2.0-preview3", "3.2.0-rc1", "3.2.0", "3.2.1", "3.2.2",
-    "3.3.0-preview1", "3.3.0-preview2",
+    "3.3.0-preview1", "3.3.0-preview2", "3.3.0-preview3", "3.3.0-rc1", "3.3.0",
     "head", "debug"
   ],
   "jruby": [
     "9.1.17.0",
     "9.2.9.0", "9.2.10.0", "9.2.11.0", "9.2.11.1", "9.2.12.0", "9.2.13.0", "9.2.14.0", "9.2.15.0", "9.2.16.0", "9.2.17.0", "9.2.18.0", "9.2.19.0", "9.2.20.0", "9.2.20.1", "9.2.21.0",
-    "9.3.0.0", "9.3.1.0", "9.3.2.0", "9.3.3.0", "9.3.4.0", "9.3.6.0", "9.3.7.0", "9.3.8.0", "9.3.9.0", "9.3.10.0", "9.3.11.0",
-    "9.4.0.0", "9.4.1.0", "9.4.2.0", "9.4.3.0",
+    "9.3.0.0", "9.3.1.0", "9.3.2.0", "9.3.3.0", "9.3.4.0", "9.3.6.0", "9.3.7.0", "9.3.8.0", "9.3.9.0", "9.3.10.0", "9.3.11.0", "9.3.13.0",
+    "9.4.0.0", "9.4.1.0", "9.4.2.0", "9.4.3.0", "9.4.4.0", "9.4.5.0",
     "head"
   ],
   "truffleruby": [
@@ -27,13 +27,13 @@
     "20.0.0", "20.1.0", "20.2.0", "20.3.0",
     "21.0.0", "21.1.0", "21.2.0", "21.2.0.1", "21.3.0",
     "22.0.0.2", "22.1.0", "22.2.0", "22.3.0", "22.3.1",
-    "23.0.0-preview1", "23.0.0", "23.1.0",
+    "23.0.0-preview1", "23.0.0", "23.1.0", "23.1.1",
     "head"
   ],
   "truffleruby+graalvm": [
     "21.2.0", "21.3.0",
     "22.0.0.2", "22.1.0", "22.2.0", "22.3.0", "22.3.1",
-    "23.0.0-preview1", "23.0.0", "23.1.0",
+    "23.0.0-preview1", "23.0.0", "23.1.0", "23.1.1",
     "head"
   ]
 }

ruby-builder.js

@@ -101,10 +101,14 @@ async function downloadAndExtract(platform, engine, version, rubyPrefix) {
 
 function getDownloadURL(platform, engine, version) {
   let builderPlatform = platform
-  if (platform.startsWith('windows-')) {
+  if (platform.startsWith('windows-') && os.arch() === 'x64') {
     builderPlatform = 'windows-latest'
   } else if (platform.startsWith('macos-')) {
-    builderPlatform = 'macos-latest'
+    if (os.arch() === 'x64') {
+      builderPlatform = 'macos-latest'
+    } else if (os.arch() === 'arm64') {
+      builderPlatform = 'macos-13-arm64'
+    }
   }
 
   if (common.isHeadVersion(version)) {

rubygems.js

@@ -1,8 +1,9 @@
+const common = require('./common')
 const path = require('path')
 const exec = require('@actions/exec')
 const semver = require('semver')
 
-export async function rubygemsUpdate(rubygemsVersionInput, rubyPrefix) {
+export async function rubygemsUpdate(rubygemsVersionInput, rubyPrefix, platform, engine, rubyVersion) {
   const gem = path.join(rubyPrefix, 'bin', 'gem')
 
   let gemVersion = ''
@@ -18,7 +19,7 @@ export async function rubygemsUpdate(rubygemsVersionInput, rubyPrefix) {
 
   if (rubygemsVersionInput === 'latest') {
     console.log('Updating RubyGems to latest version')
-    await exec.exec(gem, ['update', '--system'])
+    await rubygemsLatest(gem, platform, engine, rubyVersion)
   } else if (semver.gt(rubygemsVersionInput, gemVersion)) {
     console.log(`Updating RubyGems to ${rubygemsVersionInput}`)
     await exec.exec(gem, ['update', '--system', rubygemsVersionInput])
@@ -28,3 +29,30 @@ export async function rubygemsUpdate(rubygemsVersionInput, rubyPrefix) {
 
   return true
 }
+
+// Older RubyGems versions do not account for 'required_ruby_version' when
+// running 'gem update --system', so we have to force a compatible version of
+// rubygems-update.  See https://github.com/ruby/setup-ruby/pull/551 and
+// https://github.com/rubygems/rubygems/issues/7329
+async function rubygemsLatest(gem, platform, engine, rubyVersion) {
+  if (engine === 'ruby') {
+    const floatVersion = common.floatVersion(rubyVersion)
+    if (common.isHeadVersion(rubyVersion)) {
+      console.log('Ruby master builds use included RubyGems')
+    } else if (floatVersion >= 3.0) {
+      await exec.exec(gem, ['update', '--system'])
+    } else if (floatVersion >= 2.6) {
+      await exec.exec(gem, ['update', '--system', '3.4.22'])
+    } else if (floatVersion >= 2.3) {
+      await exec.exec(gem, ['update', '--system', '3.3.27'])
+    } else if (floatVersion >= 1.9) {
+      await exec.exec(`${gem} install rubygems-update -v 2.7.11 --no-document`)
+      await exec.exec('update_rubygems')
+    } else {
+      console.log(`Cannot update RubyGems for Ruby version ${rubyVersion}`)
+    }
+  } else {
+    // non MRI Rubies (TruffleRuby and JRuby)
+    await exec.exec(gem, ['update', '--system'])
+  }
+}

versions-strings-for-builder.rb

@@ -4,15 +4,18 @@ versions = JSON.load(hash).transform_keys(&:to_sym)
 
 by_minor = versions[:ruby].group_by { |v| v[/^\d\.\d/] }
 
-(1..7).each do |minor|
-  p by_minor["2.#{minor}"].map { |v| "ruby-#{v}" }
+by_minor.each_pair do |minor, versions|
+  puts versions.map { |v| "ruby-#{v}" }.join(', ') if minor
 end
 
 puts
-p (versions[:truffleruby] - %w[head]).map { |v| "truffleruby-#{v}" }
+puts (versions[:truffleruby] - %w[head]).map { |v| "truffleruby-#{v}" }.join(', ')
 
 puts
-p (versions[:jruby] - %w[head]).map { |v| "jruby-#{v}" }
+puts (versions[:"truffleruby+graalvm"] - %w[head]).map { |v| "truffleruby+graalvm-#{v}" }.join(', ')
+
+puts
+puts (versions[:jruby] - %w[head]).map { |v| "jruby-#{v}" }.join(', ')
 
 (versions[:jruby] - %w[head]).each do |v|
   puts "- { os: windows-latest, jruby-version: #{v}, ruby: jruby-#{v} }"

windows-versions.json

@@ -57,6 +57,7 @@
   "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",
   "3.2.2": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.2-1/rubyinstaller-3.2.2-1-x64.7z",
+  "3.3.0": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.3.0-1/rubyinstaller-3.3.0-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",