mirror of
https://github.com/actions/setup-node.git
synced 2026-02-04 14:38:19 +00:00
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
This commit is contained in:
parent
6044e13b5d
commit
844d397646
3 changed files with 116 additions and 7 deletions
37
dist/cache-save/index.js
vendored
37
dist/cache-save/index.js
vendored
|
|
@ -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) {
|
||||
|
|
|
|||
37
dist/setup/index.js
vendored
37
dist/setup/index.js
vendored
|
|
@ -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) {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue