From 844d397646215d9b3347de01f9f36dd1f075dff4 Mon Sep 17 00:00:00 2001 From: Satishchoudhary94 <148007944+Satishchoudhary94@users.noreply.github.com> Date: Sun, 18 Jan 2026 14:11:36 +0000 Subject: [PATCH] fix(#1027): Improve yarn v4+ corepack support with better error handling This change improves the action's handling of yarn v4+ which requires corepack. Changes: - Add enableCorepackIfSupported() helper function to automatically enable corepack - Update yarn getCacheFolderPath to call corepack enable before checking yarn version - Detect corepack-related errors and provide clear, actionable error messages - Users can either enable corepack before the action or disable caching The error message now clearly explains: - The requirement for corepack with yarn v4+ - How to enable corepack: 'corepack enable' - Alternative: disable caching with 'package-manager-cache: false' - Link to GitHub issue for more context Fixes #1027 Related: https://github.com/actions/setup-node/issues/1027 --- dist/cache-save/index.js | 37 +++++++++++++++++++++++++++++- dist/setup/index.js | 37 +++++++++++++++++++++++++++++- src/cache-utils.ts | 49 ++++++++++++++++++++++++++++++++++++---- 3 files changed, 116 insertions(+), 7 deletions(-) diff --git a/dist/cache-save/index.js b/dist/cache-save/index.js index 642f19dd5..b6f3781d9 100644 --- a/dist/cache-save/index.js +++ b/dist/cache-save/index.js @@ -44172,7 +44172,24 @@ exports.supportedPackageManagers = { name: 'yarn', lockFilePatterns: ['yarn.lock'], getCacheFolderPath: async (projectDir) => { - const yarnVersion = await (0, exports.getCommandOutputNotEmpty)(`yarn --version`, 'Could not retrieve version of yarn', projectDir); + // Try to enable corepack first if available + // This helps with yarn v2+ which requires corepack + await enableCorepackIfSupported(); + let yarnVersion; + try { + yarnVersion = await (0, exports.getCommandOutputNotEmpty)(`yarn --version`, 'Could not retrieve version of yarn', projectDir); + } + catch (err) { + // Check if this is a corepack error message + const errorMsg = err.message; + if (errorMsg.includes('packageManager') && + errorMsg.includes('Corepack')) { + throw new Error(`Yarn v4+ requires corepack to be enabled. Please run 'corepack enable' before using ` + + `actions/setup-node with yarn, or disable caching with 'package-manager-cache: false'. ` + + `See: https://github.com/actions/setup-node/issues/1027 for more information.`); + } + throw err; + } core.debug(`Consumed yarn version is ${yarnVersion} (working dir: "${projectDir || ''}")`); const stdOut = yarnVersion.startsWith('1.') ? await (0, exports.getCommandOutput)('yarn cache dir', projectDir) @@ -44184,6 +44201,24 @@ exports.supportedPackageManagers = { } } }; +/** + * Tries to enable corepack for Node.js versions that support it (16.9+) + * This helps with yarn v2+ which requires corepack + * See: https://github.com/actions/setup-node/issues/1027 + */ +const enableCorepackIfSupported = async () => { + try { + await exec.exec('corepack', ['enable'], { + ignoreReturnCode: true, + silent: true + }); + core.debug('Corepack enabled successfully'); + } + catch { + // Corepack not available or failed silently + core.debug('Corepack not available on this system'); + } +}; const getCommandOutput = async (toolCommand, cwd) => { let { stdout, stderr, exitCode } = await exec.getExecOutput(toolCommand, undefined, { ignoreReturnCode: true, ...(cwd && { cwd }) }); if (exitCode) { diff --git a/dist/setup/index.js b/dist/setup/index.js index c59bedb4f..e61a394ce 100644 --- a/dist/setup/index.js +++ b/dist/setup/index.js @@ -53810,7 +53810,24 @@ exports.supportedPackageManagers = { name: 'yarn', lockFilePatterns: ['yarn.lock'], getCacheFolderPath: async (projectDir) => { - const yarnVersion = await (0, exports.getCommandOutputNotEmpty)(`yarn --version`, 'Could not retrieve version of yarn', projectDir); + // Try to enable corepack first if available + // This helps with yarn v2+ which requires corepack + await enableCorepackIfSupported(); + let yarnVersion; + try { + yarnVersion = await (0, exports.getCommandOutputNotEmpty)(`yarn --version`, 'Could not retrieve version of yarn', projectDir); + } + catch (err) { + // Check if this is a corepack error message + const errorMsg = err.message; + if (errorMsg.includes('packageManager') && + errorMsg.includes('Corepack')) { + throw new Error(`Yarn v4+ requires corepack to be enabled. Please run 'corepack enable' before using ` + + `actions/setup-node with yarn, or disable caching with 'package-manager-cache: false'. ` + + `See: https://github.com/actions/setup-node/issues/1027 for more information.`); + } + throw err; + } core.debug(`Consumed yarn version is ${yarnVersion} (working dir: "${projectDir || ''}")`); const stdOut = yarnVersion.startsWith('1.') ? await (0, exports.getCommandOutput)('yarn cache dir', projectDir) @@ -53822,6 +53839,24 @@ exports.supportedPackageManagers = { } } }; +/** + * Tries to enable corepack for Node.js versions that support it (16.9+) + * This helps with yarn v2+ which requires corepack + * See: https://github.com/actions/setup-node/issues/1027 + */ +const enableCorepackIfSupported = async () => { + try { + await exec.exec('corepack', ['enable'], { + ignoreReturnCode: true, + silent: true + }); + core.debug('Corepack enabled successfully'); + } + catch { + // Corepack not available or failed silently + core.debug('Corepack not available on this system'); + } +}; const getCommandOutput = async (toolCommand, cwd) => { let { stdout, stderr, exitCode } = await exec.getExecOutput(toolCommand, undefined, { ignoreReturnCode: true, ...(cwd && { cwd }) }); if (exitCode) { diff --git a/src/cache-utils.ts b/src/cache-utils.ts index 6f45749a7..26de2a66f 100644 --- a/src/cache-utils.ts +++ b/src/cache-utils.ts @@ -40,11 +40,32 @@ export const supportedPackageManagers: SupportedPackageManagers = { name: 'yarn', lockFilePatterns: ['yarn.lock'], getCacheFolderPath: async projectDir => { - const yarnVersion = await getCommandOutputNotEmpty( - `yarn --version`, - 'Could not retrieve version of yarn', - projectDir - ); + // Try to enable corepack first if available + // This helps with yarn v2+ which requires corepack + await enableCorepackIfSupported(); + + let yarnVersion: string; + try { + yarnVersion = await getCommandOutputNotEmpty( + `yarn --version`, + 'Could not retrieve version of yarn', + projectDir + ); + } catch (err) { + // Check if this is a corepack error message + const errorMsg = (err as Error).message; + if ( + errorMsg.includes('packageManager') && + errorMsg.includes('Corepack') + ) { + throw new Error( + `Yarn v4+ requires corepack to be enabled. Please run 'corepack enable' before using ` + + `actions/setup-node with yarn, or disable caching with 'package-manager-cache: false'. ` + + `See: https://github.com/actions/setup-node/issues/1027 for more information.` + ); + } + throw err; + } core.debug( `Consumed yarn version is ${yarnVersion} (working dir: "${ @@ -66,6 +87,24 @@ export const supportedPackageManagers: SupportedPackageManagers = { } }; +/** + * Tries to enable corepack for Node.js versions that support it (16.9+) + * This helps with yarn v2+ which requires corepack + * See: https://github.com/actions/setup-node/issues/1027 + */ +const enableCorepackIfSupported = async (): Promise => { + try { + await exec.exec('corepack', ['enable'], { + ignoreReturnCode: true, + silent: true + }); + core.debug('Corepack enabled successfully'); + } catch { + // Corepack not available or failed silently + core.debug('Corepack not available on this system'); + } +}; + export const getCommandOutput = async ( toolCommand: string, cwd?: string