From 6fd6c5ccbbadf01a07708383b8291b764fac2ff7 Mon Sep 17 00:00:00 2001 From: Benoit Daloze Date: Sun, 5 Mar 2023 14:31:10 +0100 Subject: [PATCH] Use the default tool cache path on self-hosted runners matching a GH-hosted runner image * See https://github.com/ruby/setup-ruby/issues/475 * Semantically reverts 377a94bc686cee73294e510c187e34175a2fb643 --- common.js | 24 ++++++++++++++---------- dist/index.js | 27 ++++++++++++++++----------- ruby-builder.js | 2 +- 3 files changed, 31 insertions(+), 22 deletions(-) diff --git a/common.js b/common.js index 8fe2529f0..2a84ae448 100644 --- a/common.js +++ b/common.js @@ -166,17 +166,14 @@ const GitHubHostedPlatforms = [ 'windows-2022-x64', ] -// Actually a self-hosted runner for which either -// * the OS and OS version does not correspond to a GitHub-hosted runner image, -// * or the hosted tool cache is different from the default tool cache path +// 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()) || - getRunnerToolCache() !== getDefaultToolCachePath() + !GitHubHostedPlatforms.includes(getOSNameVersionArch()) } export function selfHostedRunnerReason() { @@ -184,8 +181,6 @@ export function selfHostedRunnerReason() { return 'the self-hosted input was set' } else if (!GitHubHostedPlatforms.includes(getOSNameVersionArch())) { return 'the platform does not match a GitHub-hosted runner image (or that image is deprecated and no longer supported)' - } else if (getRunnerToolCache() !== getDefaultToolCachePath()) { - return 'the $RUNNER_TOOL_CACHE is different than the default tool cache path (they must be the same to reuse prebuilt Ruby binaries)' } else { return 'unknown reason' } @@ -237,6 +232,16 @@ export function shouldUseToolCache(engine, version) { return (engine === 'ruby' && !isHeadVersion(version)) || isSelfHostedRunner() } +export function getToolCachePath() { + if (isSelfHostedRunner()) { + return getRunnerToolCache() + } else { + // Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE + // so use that path is not isSelfHostedRunner() + return getDefaultToolCachePath() + } +} + export function getRunnerToolCache() { const runnerToolCache = process.env['RUNNER_TOOL_CACHE'] if (!runnerToolCache) { @@ -245,8 +250,7 @@ export function getRunnerToolCache() { return runnerToolCache } -// Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE, -// so they can only be used if the two paths are the same +// Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE function getDefaultToolCachePath() { const platform = getVirtualEnvironmentName() if (platform.startsWith('ubuntu-')) { @@ -261,7 +265,7 @@ function getDefaultToolCachePath() { } export function getToolCacheRubyPrefix(platform, engine, version) { - const toolCache = getRunnerToolCache() + const toolCache = getToolCachePath() const name = { ruby: 'Ruby', jruby: 'JRuby', diff --git a/dist/index.js b/dist/index.js index 1312e715b..d5af80dbd 100644 --- a/dist/index.js +++ b/dist/index.js @@ -292,6 +292,7 @@ __nccwpck_require__.d(__webpack_exports__, { "floatVersion": () => (/* binding */ floatVersion), "getOSNameVersionArch": () => (/* binding */ getOSNameVersionArch), "getRunnerToolCache": () => (/* binding */ getRunnerToolCache), + "getToolCachePath": () => (/* binding */ getToolCachePath), "getToolCacheRubyPrefix": () => (/* binding */ getToolCacheRubyPrefix), "getVirtualEnvironmentName": () => (/* binding */ getVirtualEnvironmentName), "hasBundlerDefaultGem": () => (/* binding */ hasBundlerDefaultGem), @@ -521,17 +522,14 @@ const GitHubHostedPlatforms = [ 'windows-2022-x64', ] -// Actually a self-hosted runner for which either -// * the OS and OS version does not correspond to a GitHub-hosted runner image, -// * or the hosted tool cache is different from the default tool cache path +// Actually a self-hosted runner for which the OS and OS version does not correspond to a GitHub-hosted runner image, function isSelfHostedRunner() { if (inputs.selfHosted === undefined) { throw new Error('inputs.selfHosted should have been already set') } return inputs.selfHosted === 'true' || - !GitHubHostedPlatforms.includes(getOSNameVersionArch()) || - getRunnerToolCache() !== getDefaultToolCachePath() + !GitHubHostedPlatforms.includes(getOSNameVersionArch()) } function selfHostedRunnerReason() { @@ -539,8 +537,6 @@ function selfHostedRunnerReason() { return 'the self-hosted input was set' } else if (!GitHubHostedPlatforms.includes(getOSNameVersionArch())) { return 'the platform does not match a GitHub-hosted runner image (or that image is deprecated and no longer supported)' - } else if (getRunnerToolCache() !== getDefaultToolCachePath()) { - return 'the $RUNNER_TOOL_CACHE is different than the default tool cache path (they must be the same to reuse prebuilt Ruby binaries)' } else { return 'unknown reason' } @@ -592,6 +588,16 @@ function shouldUseToolCache(engine, version) { return (engine === 'ruby' && !isHeadVersion(version)) || isSelfHostedRunner() } +function getToolCachePath() { + if (isSelfHostedRunner()) { + return getRunnerToolCache() + } else { + // Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE + // so use that path is not isSelfHostedRunner() + return getDefaultToolCachePath() + } +} + function getRunnerToolCache() { const runnerToolCache = process.env['RUNNER_TOOL_CACHE'] if (!runnerToolCache) { @@ -600,8 +606,7 @@ function getRunnerToolCache() { return runnerToolCache } -// Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE, -// so they can only be used if the two paths are the same +// Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE function getDefaultToolCachePath() { const platform = getVirtualEnvironmentName() if (platform.startsWith('ubuntu-')) { @@ -616,7 +621,7 @@ function getDefaultToolCachePath() { } function getToolCacheRubyPrefix(platform, engine, version) { - const toolCache = getRunnerToolCache() + const toolCache = getToolCachePath() const name = { ruby: 'Ruby', jruby: 'JRuby', @@ -68283,7 +68288,7 @@ async function install(platform, engine, version) { if (common.isSelfHostedRunner()) { const rubyBuildDefinition = engine === 'ruby' ? version : `${engine}-${version}` core.error( - `The current runner (${common.getOSNameVersionArch()}, RUNNER_TOOL_CACHE=${common.getRunnerToolCache()}) was detected as self-hosted because ${common.selfHostedRunnerReason()}.\n` + + `The current runner (${common.getOSNameVersionArch()}) was detected as self-hosted because ${common.selfHostedRunnerReason()}.\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` + diff --git a/ruby-builder.js b/ruby-builder.js index 60388fde0..3281fe71d 100644 --- a/ruby-builder.js +++ b/ruby-builder.js @@ -28,7 +28,7 @@ export async function install(platform, engine, version) { if (common.isSelfHostedRunner()) { const rubyBuildDefinition = engine === 'ruby' ? version : `${engine}-${version}` core.error( - `The current runner (${common.getOSNameVersionArch()}, RUNNER_TOOL_CACHE=${common.getRunnerToolCache()}) was detected as self-hosted because ${common.selfHostedRunnerReason()}.\n` + + `The current runner (${common.getOSNameVersionArch()}) was detected as self-hosted because ${common.selfHostedRunnerReason()}.\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` +