mirror of
https://github.com/ruby/setup-ruby.git
synced 2026-09-13 14:34:21 +02:00
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 377a94bc68
This commit is contained in:
@@ -166,17 +166,14 @@ const GitHubHostedPlatforms = [
|
|||||||
'windows-2022-x64',
|
'windows-2022-x64',
|
||||||
]
|
]
|
||||||
|
|
||||||
// Actually a self-hosted runner for which either
|
// Actually a self-hosted runner for which the OS and OS version does not correspond to a GitHub-hosted runner image,
|
||||||
// * 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
|
|
||||||
export function isSelfHostedRunner() {
|
export function isSelfHostedRunner() {
|
||||||
if (inputs.selfHosted === undefined) {
|
if (inputs.selfHosted === undefined) {
|
||||||
throw new Error('inputs.selfHosted should have been already set')
|
throw new Error('inputs.selfHosted should have been already set')
|
||||||
}
|
}
|
||||||
|
|
||||||
return inputs.selfHosted === 'true' ||
|
return inputs.selfHosted === 'true' ||
|
||||||
!GitHubHostedPlatforms.includes(getOSNameVersionArch()) ||
|
!GitHubHostedPlatforms.includes(getOSNameVersionArch())
|
||||||
getRunnerToolCache() !== getDefaultToolCachePath()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export function selfHostedRunnerReason() {
|
export function selfHostedRunnerReason() {
|
||||||
@@ -184,8 +181,6 @@ export function selfHostedRunnerReason() {
|
|||||||
return 'the self-hosted input was set'
|
return 'the self-hosted input was set'
|
||||||
} else if (!GitHubHostedPlatforms.includes(getOSNameVersionArch())) {
|
} 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)'
|
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 {
|
} else {
|
||||||
return 'unknown reason'
|
return 'unknown reason'
|
||||||
}
|
}
|
||||||
@@ -237,6 +232,16 @@ export function shouldUseToolCache(engine, version) {
|
|||||||
return (engine === 'ruby' && !isHeadVersion(version)) || isSelfHostedRunner()
|
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() {
|
export function getRunnerToolCache() {
|
||||||
const runnerToolCache = process.env['RUNNER_TOOL_CACHE']
|
const runnerToolCache = process.env['RUNNER_TOOL_CACHE']
|
||||||
if (!runnerToolCache) {
|
if (!runnerToolCache) {
|
||||||
@@ -245,8 +250,7 @@ export function getRunnerToolCache() {
|
|||||||
return runnerToolCache
|
return runnerToolCache
|
||||||
}
|
}
|
||||||
|
|
||||||
// Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE,
|
// 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
|
|
||||||
function getDefaultToolCachePath() {
|
function getDefaultToolCachePath() {
|
||||||
const platform = getVirtualEnvironmentName()
|
const platform = getVirtualEnvironmentName()
|
||||||
if (platform.startsWith('ubuntu-')) {
|
if (platform.startsWith('ubuntu-')) {
|
||||||
@@ -261,7 +265,7 @@ function getDefaultToolCachePath() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function getToolCacheRubyPrefix(platform, engine, version) {
|
export function getToolCacheRubyPrefix(platform, engine, version) {
|
||||||
const toolCache = getRunnerToolCache()
|
const toolCache = getToolCachePath()
|
||||||
const name = {
|
const name = {
|
||||||
ruby: 'Ruby',
|
ruby: 'Ruby',
|
||||||
jruby: 'JRuby',
|
jruby: 'JRuby',
|
||||||
|
|||||||
+16
-11
@@ -292,6 +292,7 @@ __nccwpck_require__.d(__webpack_exports__, {
|
|||||||
"floatVersion": () => (/* binding */ floatVersion),
|
"floatVersion": () => (/* binding */ floatVersion),
|
||||||
"getOSNameVersionArch": () => (/* binding */ getOSNameVersionArch),
|
"getOSNameVersionArch": () => (/* binding */ getOSNameVersionArch),
|
||||||
"getRunnerToolCache": () => (/* binding */ getRunnerToolCache),
|
"getRunnerToolCache": () => (/* binding */ getRunnerToolCache),
|
||||||
|
"getToolCachePath": () => (/* binding */ getToolCachePath),
|
||||||
"getToolCacheRubyPrefix": () => (/* binding */ getToolCacheRubyPrefix),
|
"getToolCacheRubyPrefix": () => (/* binding */ getToolCacheRubyPrefix),
|
||||||
"getVirtualEnvironmentName": () => (/* binding */ getVirtualEnvironmentName),
|
"getVirtualEnvironmentName": () => (/* binding */ getVirtualEnvironmentName),
|
||||||
"hasBundlerDefaultGem": () => (/* binding */ hasBundlerDefaultGem),
|
"hasBundlerDefaultGem": () => (/* binding */ hasBundlerDefaultGem),
|
||||||
@@ -521,17 +522,14 @@ const GitHubHostedPlatforms = [
|
|||||||
'windows-2022-x64',
|
'windows-2022-x64',
|
||||||
]
|
]
|
||||||
|
|
||||||
// Actually a self-hosted runner for which either
|
// Actually a self-hosted runner for which the OS and OS version does not correspond to a GitHub-hosted runner image,
|
||||||
// * 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
|
|
||||||
function isSelfHostedRunner() {
|
function isSelfHostedRunner() {
|
||||||
if (inputs.selfHosted === undefined) {
|
if (inputs.selfHosted === undefined) {
|
||||||
throw new Error('inputs.selfHosted should have been already set')
|
throw new Error('inputs.selfHosted should have been already set')
|
||||||
}
|
}
|
||||||
|
|
||||||
return inputs.selfHosted === 'true' ||
|
return inputs.selfHosted === 'true' ||
|
||||||
!GitHubHostedPlatforms.includes(getOSNameVersionArch()) ||
|
!GitHubHostedPlatforms.includes(getOSNameVersionArch())
|
||||||
getRunnerToolCache() !== getDefaultToolCachePath()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function selfHostedRunnerReason() {
|
function selfHostedRunnerReason() {
|
||||||
@@ -539,8 +537,6 @@ function selfHostedRunnerReason() {
|
|||||||
return 'the self-hosted input was set'
|
return 'the self-hosted input was set'
|
||||||
} else if (!GitHubHostedPlatforms.includes(getOSNameVersionArch())) {
|
} 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)'
|
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 {
|
} else {
|
||||||
return 'unknown reason'
|
return 'unknown reason'
|
||||||
}
|
}
|
||||||
@@ -592,6 +588,16 @@ function shouldUseToolCache(engine, version) {
|
|||||||
return (engine === 'ruby' && !isHeadVersion(version)) || isSelfHostedRunner()
|
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() {
|
function getRunnerToolCache() {
|
||||||
const runnerToolCache = process.env['RUNNER_TOOL_CACHE']
|
const runnerToolCache = process.env['RUNNER_TOOL_CACHE']
|
||||||
if (!runnerToolCache) {
|
if (!runnerToolCache) {
|
||||||
@@ -600,8 +606,7 @@ function getRunnerToolCache() {
|
|||||||
return runnerToolCache
|
return runnerToolCache
|
||||||
}
|
}
|
||||||
|
|
||||||
// Rubies prebuilt by this action embed this path rather than using $RUNNER_TOOL_CACHE,
|
// 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
|
|
||||||
function getDefaultToolCachePath() {
|
function getDefaultToolCachePath() {
|
||||||
const platform = getVirtualEnvironmentName()
|
const platform = getVirtualEnvironmentName()
|
||||||
if (platform.startsWith('ubuntu-')) {
|
if (platform.startsWith('ubuntu-')) {
|
||||||
@@ -616,7 +621,7 @@ function getDefaultToolCachePath() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function getToolCacheRubyPrefix(platform, engine, version) {
|
function getToolCacheRubyPrefix(platform, engine, version) {
|
||||||
const toolCache = getRunnerToolCache()
|
const toolCache = getToolCachePath()
|
||||||
const name = {
|
const name = {
|
||||||
ruby: 'Ruby',
|
ruby: 'Ruby',
|
||||||
jruby: 'JRuby',
|
jruby: 'JRuby',
|
||||||
@@ -68283,7 +68288,7 @@ async function install(platform, engine, version) {
|
|||||||
if (common.isSelfHostedRunner()) {
|
if (common.isSelfHostedRunner()) {
|
||||||
const rubyBuildDefinition = engine === 'ruby' ? version : `${engine}-${version}`
|
const rubyBuildDefinition = engine === 'ruby' ? version : `${engine}-${version}`
|
||||||
core.error(
|
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` +
|
`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` +
|
`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` +
|
`$ ruby-build ${rubyBuildDefinition} ${toolCacheRubyPrefix}\n` +
|
||||||
|
|||||||
+1
-1
@@ -28,7 +28,7 @@ export async function install(platform, engine, version) {
|
|||||||
if (common.isSelfHostedRunner()) {
|
if (common.isSelfHostedRunner()) {
|
||||||
const rubyBuildDefinition = engine === 'ruby' ? version : `${engine}-${version}`
|
const rubyBuildDefinition = engine === 'ruby' ? version : `${engine}-${version}`
|
||||||
core.error(
|
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` +
|
`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` +
|
`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` +
|
`$ ruby-build ${rubyBuildDefinition} ${toolCacheRubyPrefix}\n` +
|
||||||
|
|||||||
Reference in New Issue
Block a user