Update CRuby releases on Windows

* Remove the ASan Debugging section for now as it seems mostly redundant.
  Native extensions are automatically compiled with ASan, so there is nothing special to do to use it.

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

.github/workflows/release.yml

@@ -1,17 +1,24 @@
-name: Update the v1 branch when a release is published
+name: Create a Release
 on:
-  release:
-    types: [published]
+  workflow_dispatch:
 permissions:
-  contents: read
+  contents: write # for creating release
 
 jobs:
   release:
     runs-on: ubuntu-latest
-    permissions:
-      contents: write # for git push
+    env:
+      GH_TOKEN: ${{ github.token }}
+      GH_REPO: ${{ github.repository }}
     steps:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+    - uses: ./
+      with:
+        ruby-version: '3.3'
+    - run: ruby release.rb
+    # The same as the update-v1-branch.yml workflow.
+    # That workflow is not triggered by the release created above because of
+    # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow
     - run: git push origin HEAD:v1

.github/workflows/test.yml

@@ -17,9 +17,9 @@ 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, ubuntu-24.04, macos-12, macos-13, macos-14, macos-15, 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,
+          '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', '3.4', ruby-head,
           jruby, jruby-head,
           truffleruby, truffleruby-head,
           truffleruby+graalvm, truffleruby+graalvm-head
@@ -30,21 +30,41 @@ jobs:
         - { os: windows-2022, ruby: mingw }
         - { os: windows-2022, ruby: mswin }
         - { os: windows-2022, ruby: ucrt  }
+        - { os: ubuntu-24.04, ruby: asan }
         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' }
+        - { os: ubuntu-24.04, ruby: '1.9' }
+        - { os: ubuntu-24.04, ruby: '2.2' }
+        # These old Rubies fail to compile on macOS arm64
+        - { os: macos-14, ruby: '1.9' }
+        - { os: macos-14, ruby: '2.0' }
+        - { os: macos-14, ruby: '2.1' }
+        - { os: macos-14, ruby: '2.2' }
+        - { os: macos-14, ruby: '2.3' }
+        - { os: macos-14, ruby: '2.4' }
+        - { os: macos-14, ruby: '2.5' }
+        - { os: macos-15, ruby: '1.9' }
+        - { os: macos-15, ruby: '2.0' }
+        - { os: macos-15, ruby: '2.1' }
+        - { os: macos-15, ruby: '2.2' }
+        - { os: macos-15, ruby: '2.3' }
+        - { os: macos-15, ruby: '2.4' }
+        - { os: macos-15, ruby: '2.5' }
+        # Windows (note: previews are not available on Windows)
         - { os: windows-2019, ruby: '1.9' }
-        - { os: windows-2019, ruby: '3.3' }
-        - { os: windows-2019, ruby: debug }
-        - { os: windows-2019, ruby: truffleruby }
-        - { os: windows-2019, ruby: truffleruby-head }
-        - { os: windows-2019, ruby: truffleruby+graalvm }
-        - { os: windows-2019, ruby: truffleruby+graalvm-head }
         - { os: windows-2022, ruby: '1.9' }
-        - { os: windows-2022, ruby: '3.3' }
+        - { os: windows-2019, ruby: '3.4' } # 3.4.0-preview2
+        - { os: windows-2022, ruby: '3.4' } # 3.4.0-preview2
+        - { os: windows-2019, ruby: debug }
         - { os: windows-2022, ruby: debug }
+        - { os: windows-2019, ruby: truffleruby }
         - { os: windows-2022, ruby: truffleruby }
+        - { os: windows-2019, ruby: truffleruby-head }
         - { os: windows-2022, ruby: truffleruby-head }
+        - { os: windows-2019, ruby: truffleruby+graalvm }
         - { os: windows-2022, ruby: truffleruby+graalvm }
+        - { os: windows-2019, ruby: truffleruby+graalvm-head }
         - { os: windows-2022, ruby: truffleruby+graalvm-head }
 
     name: ${{ matrix.os }} ${{ matrix.ruby }}
@@ -159,15 +179,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"
@@ -314,6 +345,19 @@ jobs:
           bundler-cache: true
       - run: bundle list | grep nokogiri
 
+  testWindowsToolchain:
+    name: "Test windows-toolchain: none"
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./
+        with:
+          ruby-version: '2.7'
+          windows-toolchain: none
+          bundler: none
+      - name: C:/msys64/mingw64/bin/gcc.exe not installed
+        run: ruby -e "abort if File.exist?('C:/msys64/mingw64/bin/gcc.exe')"
+
   lint:
     runs-on: ubuntu-20.04
     steps:

.github/workflows/update-v1-branch.yml

@@ -0,0 +1,15 @@
+name: Update the v1 branch when a release is published manually
+on:
+  release:
+    types: [published]
+permissions:
+  contents: write # for git push
+
+jobs:
+  update_branch:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - run: git push origin HEAD:v1

.ruby-version

@@ -1 +0,0 @@
-ruby-2.6.5

.tool-versions

@@ -1,2 +0,0 @@
-nodejs 16.0.0
-ruby 2.7.0

CONTRIBUTING.md

@@ -24,3 +24,7 @@ $ cp pre-commit .git/hooks/pre-commit
 
 This is entirely automated now since [this issue](https://github.com/ruby/setup-ruby/issues/254).
 If you do not see a new version more than 24 hours after it was released feel free to file an issue.
+
+## Release
+
+Maintainers can create a release automatically by running [this workflow](https://github.com/ruby/setup-ruby/actions/workflows/release.yml).

README.md

@@ -15,12 +15,16 @@ 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.4.0-preview2, head, debug, mingw, mswin, ucrt |
+| `jruby` | 9.1.17.0 - 9.4.8.0, head |
+| `truffleruby` | 19.3.0 - 24.1.1, head |
+| `truffleruby+graalvm` | 21.2.0 - 24.1.1, head |
 
-`ruby-debug` is the same as `ruby-head` but with assertions enabled (`-DRUBY_DEBUG=1`).  
+`ruby-debug` is the same as `ruby-head` but with assertions enabled (`-DRUBY_DEBUG=1`).
+
+`ruby-asan` is the same as `ruby-head` but with AddressSanitizer (ASan) enabled, helpful for finding memory issues in native extensions.
+Native extensions are automatically compiled with AddressSanitizer when using `ruby-asan`.
+`ruby-asan` is currently only available on `ubuntu-24.04`.
 
 Regarding Windows ruby master builds, `mingw` is a MSYS2/MinGW build, `head` & `ucrt` are MSYS2/UCRT64
 builds, and `mswin` is a MSVC/VS 2022 build.
@@ -38,12 +42,12 @@ which means Ruby ≤ 2.4 is unmaintained and considered insecure.
 
 ### Supported Platforms
 
-The action works on these [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources) images. Runner images not listed below are not supported yet. `$OS-latest` just alias to one of these images.
+The action works on these [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources) images. Runner images not listed below are not supported yet. `$OS-latest` just alias to one of these images.
 
 | Operating System | Supported |
 | ---------------- | --------- |
-| Ubuntu  | `ubuntu-20.04`, `ubuntu-22.04` |
-| macOS   | `macos-11`, `macos-12`, `macos-13` |
+| Ubuntu  | `ubuntu-20.04`, `ubuntu-22.04`, `ubuntu-24.04` |
+| macOS   | `macos-12`, `macos-13`, `macos-14` |
 | Windows | `windows-2019`, `windows-2022` |
 
 The prebuilt releases are generated by [ruby-builder](https://github.com/ruby/ruby-builder)
@@ -51,10 +55,10 @@ and on Windows by [RubyInstaller2](https://github.com/oneclick/rubyinstaller2).
 The `mingw`, `ucrt` and `mswin` builds are generated by [ruby-loco](https://github.com/MSP-Greg/ruby-loco).
 `ruby-head` is generated by [ruby-dev-builder](https://github.com/ruby/ruby-dev-builder),
 `jruby-head` is generated by [jruby-dev-builder](https://github.com/ruby/jruby-dev-builder),
-`truffleruby-head` is generated by [truffleruby-dev-builder](https://github.com/ruby/truffleruby-dev-builder)
-and `truffleruby+graalvm` is generated by [graalvm-ce-dev-builds](https://github.com/graalvm/graalvm-ce-dev-builds).
-The full list of available Ruby versions can be seen in [ruby-builder-versions.json](ruby-builder-versions.json)
-for Ubuntu and macOS and in [windows-versions.json](windows-versions.json) for Windows.
+`truffleruby-head` and `truffleruby+graalvm-head` are 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.json](ruby-builder-versions.json) for Ubuntu and macOS
+(although some combinations are not available, see [the full list](https://github.com/ruby/ruby-builder/releases/tag/toolcache))
+and in [windows-versions.json](windows-versions.json) for Windows.
 
 ## Usage
 
@@ -70,7 +74,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` or `.tool-versions`
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - run: bundle exec rake
 ```
@@ -89,7 +93,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 +122,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
 ```
@@ -233,6 +237,7 @@ 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`.
 * Use JRuby 9.2.20+ on Windows (older versions have [bugs](https://github.com/ruby/setup-ruby/issues/18#issuecomment-889072695)).
 * JRuby on Windows has multiple issues ([jruby/jruby#7106](https://github.com/jruby/jruby/issues/7106), [jruby/jruby#7182](https://github.com/jruby/jruby/issues/7182)).
+* When compiling extension code, note that the packages required to build Ruby are included when using Windows 2022, but that Windows 2019 does not include all of them, and may require installing package(s).  This can be done with [setup-ruby-pkgs](https://github.com/ruby/setup-ruby-pkgs) or via MSYS2's pacman.  These packages may be required when installing or updating Ruby std-lib extension gems.
 
 ## Versioning
 
@@ -263,6 +268,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,19 @@ 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.
+  windows-toolchain:
+    description: |
+      This input allows to override the default toolchain setup on Windows.
+      The default setting ('default') installs a toolchain based on the selected Ruby.
+      Specifically, it installs MSYS2 if not already there and installs mingw/ucrt/mswin build tools and packages.
+      It also sets environment variables using 'ridk' or 'vcvars64.bat' based on the selected Ruby.
+      At present, the only other setting than 'default' is 'none', which only adds Ruby to PATH.
+      No build tools or packages are installed, nor are any ENV setting changed to activate them.
+
 outputs:
   ruby-prefix:
     description: 'The prefix of the installed ruby'
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'

common.js

@@ -8,7 +8,6 @@ const core = require('@actions/core')
 const tc = require('@actions/tool-cache')
 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
@@ -67,7 +66,7 @@ export async function time(name, block) {
 }
 
 export function isHeadVersion(rubyVersion) {
-  return ['head', 'debug',  'mingw', 'mswin', 'ucrt'].includes(rubyVersion)
+  return ['head', 'debug',  'mingw', 'mswin', 'ucrt', 'asan'].includes(rubyVersion)
 }
 
 export function isStableVersion(engine, rubyVersion) {
@@ -162,70 +161,105 @@ export async function hashFile(file) {
   return hash.digest('hex')
 }
 
+// macos is not listed explicitly, see below
 const GitHubHostedPlatforms = [
   'ubuntu-20.04-x64',
   'ubuntu-22.04-x64',
-  'macos-11-x64',
-  'macos-12-x64',
-  'macos-13-x64',
+  'ubuntu-24.04-x64',
   '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,
+// Precisely: whether we have builds for that platform and there are GitHub-hosted runners to test it
+function isSupportedPlatform() {
+  const platform = getOSName()
+  switch (platform) {
+    case 'ubuntu':
+      return GitHubHostedPlatforms.includes(getOSNameVersionArch())
+    case 'macos':
+      // See https://github.com/ruby/ruby-builder/blob/master/README.md#naming
+      // 13 on arm64 because of old macos-arm-oss runners
+      return (os.arch() === 'x64' && parseInt(getOSVersion()) >= 12) ||
+          (os.arch() === 'arm64' && parseInt(getOSVersion()) >= 13)
+    case 'windows':
+      return GitHubHostedPlatforms.includes(getOSNameVersionArch())
+  }
+}
+
+// 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')
   }
 
-  return inputs.selfHosted === 'true' ||
-    !GitHubHostedPlatforms.includes(getOSNameVersionArch())
+  return inputs.selfHosted === 'true' || !isSupportedPlatform()
 }
 
 export function selfHostedRunnerReason() {
   if (inputs.selfHosted === 'true') {
     return 'the self-hosted input was set'
-  } else if (!GitHubHostedPlatforms.includes(getOSNameVersionArch())) {
+  } else if (!isSupportedPlatform()) {
     return 'the platform does not match a GitHub-hosted runner image (or that image is deprecated and no longer supported)'
   } else {
     return 'unknown reason'
   }
 }
 
-let virtualEnvironmentName = undefined
+let osName = undefined
+let osVersion = undefined
 
-export function getVirtualEnvironmentName() {
-  if (virtualEnvironmentName !== undefined) {
-    return virtualEnvironmentName
+export function getOSName() {
+  if (osName !== undefined) {
+    return osName
   }
 
   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'
+  } else {
+    throw new Error(`Unknown platform ${platform}`)
+  }
+
+  return osName
+}
+
+export function getOSVersion() {
+  if (osVersion !== undefined) {
+    return osVersion
+  }
+
+  const platform = os.platform()
+  if (platform === 'linux') {
+    const info = linuxOSInfo({mode: 'sync'})
+    osVersion = info.version_id
+  } else if (platform === 'darwin') {
+    // See https://github.com/sindresorhus/macos-release/blob/main/index.js
+    const darwinVersion = parseInt(os.release().match(/^\d+/)[0])
+    osVersion = `${darwinVersion - 9}`
+  } else if (platform === 'win32') {
     osVersion = findWindowsVersion()
   } else {
     throw new Error(`Unknown platform ${platform}`)
   }
 
-  virtualEnvironmentName = `${osName}-${osVersion}`
-  return virtualEnvironmentName
+  return osVersion
+}
+
+export function getOSNameVersion() {
+  return `${getOSName()}-${getOSVersion()}`
 }
 
 export function getOSNameVersionArch() {
-  return `${getVirtualEnvironmentName()}-${os.arch()}`
+  return `${getOSName()}-${getOSVersion()}-${os.arch()}`
 }
 
 function findWindowsVersion() {
-  const version = os.version();
+  const version = os.version()
   const match = version.match(/^Windows Server (\d+) Datacenter/)
   if (match) {
     return match[1]
@@ -243,7 +277,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,15 +292,14 @@ export function getRunnerToolCache() {
 
 // Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE
 function getDefaultToolCachePath() {
-  const platform = getVirtualEnvironmentName()
-  if (platform.startsWith('ubuntu-')) {
-    return '/opt/hostedtoolcache'
-  } else if (platform.startsWith('macos-')) {
-    return '/Users/runner/hostedtoolcache'
-  } else if (platform.startsWith('windows-')) {
-    return 'C:\\hostedtoolcache\\windows'
-  } else {
-    throw new Error('Unknown platform')
+  const platform = getOSName()
+  switch (platform) {
+    case 'ubuntu':
+      return '/opt/hostedtoolcache'
+    case 'macos':
+      return '/Users/runner/hostedtoolcache'
+    case 'windows':
+      return 'C:\\hostedtoolcache\\windows'
   }
 }
 
@@ -340,7 +373,8 @@ export function setupPath(newPathEntries) {
 
   // Then add new path entries using core.addPath()
   let newPath
-  if (windows) {
+  const windowsToolchain = core.getInput('windows-toolchain')
+  if (windows && windowsToolchain !== 'none') {
     // main Ruby dll determines whether mingw or ucrt build
     msys2Type = rubyIsUCRT(newPathEntries[0]) ? 'ucrt64' : 'mingw64'
 

index.js

@@ -17,6 +17,7 @@ const inputDefaults = {
   'working-directory': '.',
   'cache-version': bundler.DEFAULT_CACHE_VERSION,
   'self-hosted': 'false',
+  'windows-toolchain': 'default',
 }
 
 // entry point when this action is run on its own
@@ -30,6 +31,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 +48,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
@@ -54,8 +58,14 @@ export async function setupRuby(options = {}) {
     installer = require('./ruby-builder')
   }
 
-  const engineVersions = installer.getAvailableVersions(platform, engine)
-  const version = validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion)
+  let version
+  if (common.isSelfHostedRunner()) {
+    // The list of available Rubies in the hostedtoolcache is unrelated to getAvailableVersions()
+    version = parsedVersion
+  } else {
+    const engineVersions = installer.getAvailableVersions(platform, engine)
+    version = validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion)
+  }
 
   createGemRC(engine, version)
   envPreInstall()
@@ -75,7 +85,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
@@ -155,11 +165,35 @@ function validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVe
       version = found
     } else {
       throw new Error(`Unknown version ${parsedVersion} for ${engine} on ${platform}
-        available versions for ${engine} on ${platform}: ${engineVersions.join(', ')}
+        Available versions for ${engine} on ${platform}: ${engineVersions.join(', ')}
         Make sure you use the latest version of the action with - uses: ruby/setup-ruby@v1`)
     }
   }
 
+  // Well known version-platform combinations which do not work:
+  if (engine === 'ruby' && platform.startsWith('macos') && os.arch() === 'arm64' && common.floatVersion(version) < 2.6) {
+    throw new Error(`CRuby < 2.6 does not support macos-arm64.
+        Either use a newer Ruby version or use a macOS image running on amd64, e.g., macos-13 or macos-12.
+        Note that GitHub changed the meaning of macos-latest from macos-12 (amd64) to macos-14 (arm64):
+        https://github.blog/changelog/2024-04-01-macos-14-sonoma-is-generally-available-and-the-latest-macos-runner-image/
+
+        If you are using a matrix of Ruby versions, a good solution is to run only < 2.6 on amd64, like so:
+        matrix:
+          ruby: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
+          os: [ ubuntu-latest, macos-latest ]
+          # CRuby < 2.6 does not support macos-arm64, so test those on amd64 instead
+          exclude:
+          - { os: macos-latest, ruby: '2.4' }
+          - { os: macos-latest, ruby: '2.5' }
+          include:
+          - { os: macos-13, ruby: '2.4' }
+          - { os: macos-13, ruby: '2.5' }
+
+        But of course you should consider dropping support for these long-EOL Rubies, which cannot even be built on recent macOS machines.`)
+  } else if (engine === 'truffleruby' && platform.startsWith('windows')) {
+    throw new Error('TruffleRuby does not currently support Windows.')
+  }
+
   return version
 }
 

package.json

@@ -28,7 +28,6 @@
     "@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": {

release.rb

@@ -0,0 +1,17 @@
+require 'json'
+
+def run(command_line)
+  puts "$ #{command_line}"
+  output = `#{command_line}`
+  puts output
+  raise $?.inspect unless $?.success?
+  output
+end
+
+latest_release_tag = run 'gh release view --json tagName'
+latest_release_tag = JSON.load(latest_release_tag).fetch('tagName')
+
+raise latest_release_tag unless latest_release_tag =~ /\Av(\d+).(\d+).(\d+)\z/
+tag = "v#{$1}.#{Integer($2)+1}.0"
+
+run "gh release create --generate-notes --latest #{tag}"

ruby-builder-versions.json

@@ -9,17 +9,18 @@
     "2.5.0", "2.5.1", "2.5.2", "2.5.3", "2.5.4", "2.5.5", "2.5.6", "2.5.7", "2.5.8", "2.5.9",
     "2.6.0", "2.6.1", "2.6.2", "2.6.3", "2.6.4", "2.6.5", "2.6.6", "2.6.7", "2.6.8", "2.6.9", "2.6.10",
     "2.7.0", "2.7.1", "2.7.2", "2.7.3", "2.7.4", "2.7.5", "2.7.6", "2.7.7", "2.7.8",
-    "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",
-    "head", "debug"
+    "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.0.7",
+    "3.1.0-preview1", "3.1.0", "3.1.1", "3.1.2", "3.1.3", "3.1.4", "3.1.5", "3.1.6",
+    "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.2.3", "3.2.4", "3.2.5", "3.2.6",
+    "3.3.0-preview1", "3.3.0-preview2", "3.3.0-preview3", "3.3.0-rc1", "3.3.0", "3.3.1", "3.3.2", "3.3.3", "3.3.4", "3.3.5",
+    "3.4.0-preview1", "3.4.0-preview2",
+    "head", "debug", "asan"
   ],
   "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.3.14.0", "9.3.15.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", "9.4.6.0", "9.4.7.0", "9.4.8.0",
     "head"
   ],
   "truffleruby": [
@@ -27,13 +28,15 @@
     "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", "23.1.2",
+    "24.0.0", "24.0.1", "24.0.2", "24.1.0", "24.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", "23.1.2",
+    "24.0.0", "24.0.1", "24.0.2", "24.1.0", "24.1.1",
     "head"
   ]
 }

ruby-builder.js

@@ -51,38 +51,35 @@ export async function install(platform, engine, version) {
 
   if (!inToolCache) {
     await io.mkdirP(rubyPrefix)
-    if (engine === 'truffleruby+graalvm') {
-      await installWithRubyBuild(engine, version, rubyPrefix)
-    } else {
-      await downloadAndExtract(platform, engine, version, rubyPrefix)
-    }
+    await downloadAndExtract(platform, engine, version, rubyPrefix)
+  }
+
+  // https://github.com/oracle/truffleruby/issues/3390
+  if (engine.startsWith('truffleruby') && common.floatVersion(version) >= 24.0 && !common.isSelfHostedRunner() && common.getOSNameVersionArch() === 'macos-12-x64') {
+    console.log('Setting MACOSX_DEPLOYMENT_TARGET=11.0 to workaround bug in XCode 14.2 linker not respecting RTLD_LAZY, see https://github.com/oracle/truffleruby/issues/3390')
+    core.exportVariable('MACOSX_DEPLOYMENT_TARGET', '11.0')
   }
 
   return rubyPrefix
 }
 
-async function installWithRubyBuild(engine, version, rubyPrefix) {
-  const tmp = process.env['RUNNER_TEMP'] || os.tmpdir()
-  const rubyBuildDir = path.join(tmp, 'ruby-build-for-setup-ruby')
-  await common.measure('Cloning ruby-build', async () => {
-    await exec.exec('git', ['clone', 'https://github.com/rbenv/ruby-build.git', rubyBuildDir])
-  })
-
-  const rubyName = `${engine}-${version === 'head' ? 'dev' : version}`
-  await common.measure(`Installing ${engine}-${version} with ruby-build`, async () => {
-    await exec.exec(`${rubyBuildDir}/bin/ruby-build`, [rubyName, rubyPrefix])
-  })
-
-  await io.rmRF(rubyBuildDir)
-}
-
 async function downloadAndExtract(platform, engine, version, rubyPrefix) {
   const parentDir = path.dirname(rubyPrefix)
 
   const downloadPath = await common.measure('Downloading Ruby', async () => {
     const url = getDownloadURL(platform, engine, version)
     console.log(url)
-    return await tc.downloadTool(url)
+    try {
+      return await tc.downloadTool(url)
+    } catch (error) {
+      if (error.message.includes('404')) {
+        throw new Error(`Unavailable version ${version} for ${engine} on ${platform}
+          You can request it at https://github.com/ruby/setup-ruby/issues
+          Cause: ${error.message}`)
+      } else {
+        throw error
+      }
+    }
   })
 
   await common.measure('Extracting  Ruby', async () => {
@@ -101,10 +98,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)) {
@@ -115,5 +116,9 @@ function getDownloadURL(platform, engine, version) {
 }
 
 function getLatestHeadBuildURL(platform, engine, version) {
-  return `https://github.com/ruby/${engine}-dev-builder/releases/latest/download/${engine}-${version}-${platform}.tar.gz`
+  var repo = `${engine}-dev-builder`
+  if (engine === 'truffleruby+graalvm') {
+    repo = 'truffleruby-dev-builder'
+  }
+  return `https://github.com/ruby/${repo}/releases/latest/download/${engine}-${version}-${platform}.tar.gz`
 }

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

@@ -49,14 +49,27 @@
   "3.0.4": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.0.4-1/rubyinstaller-3.0.4-1-x64.7z",
   "3.0.5": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.0.5-1/rubyinstaller-3.0.5-1-x64.7z",
   "3.0.6": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.0.6-1/rubyinstaller-3.0.6-1-x64.7z",
+  "3.0.7": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.0.7-1/rubyinstaller-3.0.7-1-x64.7z",
   "3.1.0": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.1.0-1/rubyinstaller-3.1.0-1-x64.7z",
   "3.1.1": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.1.1-1/rubyinstaller-3.1.1-1-x64.7z",
   "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.1.4": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.1.4-1/rubyinstaller-3.1.4-1-x64.7z",
+  "3.1.5": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.1.5-1/rubyinstaller-3.1.5-1-x64.7z",
+  "3.1.6": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.1.6-1/rubyinstaller-3.1.6-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",
   "3.2.2": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.2-1/rubyinstaller-3.2.2-1-x64.7z",
+  "3.2.3": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.3-1/rubyinstaller-3.2.3-1-x64.7z",
+  "3.2.4": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.4-1/rubyinstaller-3.2.4-1-x64.7z",
+  "3.2.5": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.5-1/rubyinstaller-3.2.5-1-x64.7z",
+  "3.2.6": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.6-1/rubyinstaller-3.2.6-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",
+  "3.3.1": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.3.1-1/rubyinstaller-3.3.1-1-x64.7z",
+  "3.3.2": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.3.2-1/rubyinstaller-3.3.2-1-x64.7z",
+  "3.3.3": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.3.3-1/rubyinstaller-3.3.3-1-x64.7z",
+  "3.3.4": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.3.4-1/rubyinstaller-3.3.4-1-x64.7z",
+  "3.3.5": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.3.5-1/rubyinstaller-3.3.5-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

@@ -65,12 +65,17 @@ export async function install(platform, engine, version) {
     rubyPrefix = `${drive}:\\${base}`
   }
 
-  let toolchainPaths = (version === 'mswin') ? await setupMSWin() : await setupMingw(version)
-
   if (!inToolCache) {
     await downloadAndExtract(engine, version, url, base, rubyPrefix);
   }
 
+  const windowsToolchain = core.getInput('windows-toolchain')
+  if (windowsToolchain === 'none') {
+    common.setupPath([`${rubyPrefix}\\bin`])
+    return rubyPrefix
+  }
+
+  let toolchainPaths = (version === 'mswin') ? await setupMSWin() : await setupMingw(version)
   const msys2Type = common.setupPath([`${rubyPrefix}\\bin`, ...toolchainPaths])
 
   // install msys2 tools for all Ruby versions, only install mingw or ucrt for Rubies >= 2.4

yarn.lock

@@ -281,11 +281,6 @@ lru-cache@^6.0.0:
   dependencies:
     yallist "^4.0.0"
 
-macos-release@^3.1.0:
-  version "3.2.0"
-  resolved "https://registry.yarnpkg.com/macos-release/-/macos-release-3.2.0.tgz#dcee82b6a4932971b1538dbf6f3aabc4a903b613"
-  integrity sha512-fSErXALFNsnowREYZ49XCdOHF8wOPWuFOGQrAhP7x5J/BqQv+B02cNsTykGpDgRVx43EKg++6ANmTaGTtW+hUA==
-
 mime-db@1.52.0:
   version "1.52.0"
   resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70"