Fix updating the v1 branch on automated releases

* Fixes https://github.com/ruby/setup-ruby/issues/618

.github/workflows/release.yml

@@ -1,17 +1,24 @@
-name: Update the v1 branch when a release is published
+name: Create a Release
 on:
-  release:
+  workflow_dispatch:
-    types: [published]
 permissions:
-  contents: read
+  contents: write # for creating release
 
 jobs:
   release:
     runs-on: ubuntu-latest
-    permissions:
+    env:
-      contents: write # for git push
+      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,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-20.04, ubuntu-22.04, macos-11, macos-12, macos-13, macos-14, macos-arm-oss, windows-2019, windows-2022 ]
+        os: [ ubuntu-20.04, ubuntu-22.04, ubuntu-24.04, macos-12, macos-13, macos-14, 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,
@@ -33,7 +33,9 @@ jobs:
         exclude:
         # https://github.com/ruby/setup-ruby/issues/496
         - { os: ubuntu-22.04, ruby: '2.2' }
-        # These old Rubies fail to compile on macos-arm-oss (macOS 13, arm64), which is used for ruby/ruby-builder
+        - { os: ubuntu-24.04, ruby: '1.9' }
+        - { os: ubuntu-24.04, ruby: '2.2' }
+        # These old Rubies fail to compile on macos-14 (macOS 14, arm64), which is used for ruby/ruby-builder
         - { os: macos-14, ruby: '1.9' }
         - { os: macos-14, ruby: '2.0' }
         - { os: macos-14, ruby: '2.1' }
@@ -41,13 +43,6 @@ jobs:
         - { os: macos-14, ruby: '2.3' }
         - { os: macos-14, ruby: '2.4' }
         - { os: macos-14, ruby: '2.5' }
-        - { 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: debug }

.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,12 @@ 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.1, head, debug, mingw, mswin, ucrt |
+| `ruby` | 1.9.3, 2.0.0, 2.1.9, 2.2, all versions from 2.3.0 until 3.4.0-preview1, head, debug, mingw, mswin, ucrt |
-| `jruby` | 9.1.17.0 - 9.4.7.0, head |
+| `jruby` | 9.1.17.0 - 9.4.8.0, head |
 | `truffleruby` | 19.3.0 - 24.0.1, head |
 | `truffleruby+graalvm` | 21.2.0 - 24.0.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`).
 
 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.
@@ -42,8 +42,8 @@ The action works on these [GitHub-hosted runners](https://docs.github.com/en/act
 
 | Operating System | Supported |
 | ---------------- | --------- |
-| Ubuntu  | `ubuntu-20.04`, `ubuntu-22.04` |
+| Ubuntu  | `ubuntu-20.04`, `ubuntu-22.04`, `ubuntu-24.04` |
-| macOS   | `macos-11`, `macos-12`, `macos-13`, `macos-14` |
+| 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)

common.js

@@ -165,7 +165,7 @@ export async function hashFile(file) {
 const GitHubHostedPlatforms = [
   'ubuntu-20.04-x64',
   'ubuntu-22.04-x64',
-  'macos-11-x64',
+  'ubuntu-24.04-x64',
   'macos-12-x64',
   'macos-13-x64',
   'macos-13-arm64',

index.js

@@ -58,8 +58,14 @@ export async function setupRuby(options = {}) {
     installer = require('./ruby-builder')
   }
 
-  const engineVersions = installer.getAvailableVersions(platform, engine)
+  let version
-  const version = validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion)
+  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()
@@ -159,11 +165,33 @@ 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.`)
+  }
+
   return version
 }
 

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

@@ -10,16 +10,17 @@
     "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.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.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.3.0-preview1", "3.3.0-preview2", "3.3.0-preview3", "3.3.0-rc1", "3.3.0", "3.3.1",
+    "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.4.0-preview1",
     "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.3.13.0", "9.3.14.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.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": [

ruby-builder.js

@@ -51,11 +51,7 @@ export async function install(platform, engine, version) {
 
   if (!inToolCache) {
     await io.mkdirP(rubyPrefix)
-    if (engine === 'truffleruby+graalvm') {
+    await downloadAndExtract(platform, engine, version, rubyPrefix)
-      await installWithRubyBuild(engine, version, rubyPrefix)
-    } else {
-      await downloadAndExtract(platform, engine, version, rubyPrefix)
-    }
   }
 
   // https://github.com/oracle/truffleruby/issues/3390
@@ -67,28 +63,23 @@ export async function install(platform, engine, version) {
   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 () => {
@@ -125,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`
 }

windows-versions.json

@@ -56,6 +56,7 @@
   "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",
@@ -63,6 +64,8 @@
   "3.2.4": "https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.4-1/rubyinstaller-3.2.4-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",
   "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",