mirror of
https://github.com/pnpm/action-setup.git
synced 2026-05-15 06:43:32 +08:00
Compare commits
2 Commits
fix/233
...
fix-standa
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3ecdba80af | ||
|
|
739bfe42ca |
96
.github/workflows/test.yaml
vendored
96
.github/workflows/test.yaml
vendored
@@ -194,6 +194,102 @@ jobs:
|
|||||||
pnpm add is-odd
|
pnpm add is-odd
|
||||||
shell: bash
|
shell: bash
|
||||||
|
|
||||||
|
standalone_windows_self_update:
|
||||||
|
# Regression guard for the patchPnpmEnv PATH-shadow bug. When
|
||||||
|
# standalone: true on Windows AND the requested pnpm differs from the
|
||||||
|
# bootstrap, the previous patchPnpmEnv prepended node_modules/.bin to
|
||||||
|
# PATH; that directory contains an npm-created pnpm.cmd shim pointing
|
||||||
|
# at the BOOTSTRAP pnpm, which shadowed the self-updated pnpm at
|
||||||
|
# $PNPM_HOME/bin and caused `pnpm install` inside the action to run
|
||||||
|
# under the bootstrap version. Exercising a newer-pnpm-only flag
|
||||||
|
# (`--no-runtime`, added in 11.1.0) makes the regression assertable:
|
||||||
|
# if the bootstrap (11.0.4) handles the install, it errors with
|
||||||
|
# "Unknown option: 'runtime'".
|
||||||
|
name: 'Standalone Windows self-update (PATH regression)'
|
||||||
|
runs-on: windows-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
|
||||||
|
|
||||||
|
- name: Set up package.json with a minimal manifest
|
||||||
|
# run_install needs a manifest to install against. Removing the
|
||||||
|
# repo's existing pnpm-lock.yaml avoids frozen-lockfile mismatch.
|
||||||
|
run: |
|
||||||
|
rm -f pnpm-lock.yaml
|
||||||
|
echo '{"name":"sw","private":true,"packageManager":"pnpm@11.1.0"}' > package.json
|
||||||
|
shell: bash
|
||||||
|
|
||||||
|
- name: Run the action
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
version: 11.1.0
|
||||||
|
standalone: true
|
||||||
|
run_install: |
|
||||||
|
args: ['--no-runtime']
|
||||||
|
|
||||||
|
- name: 'Test: pnpm install completed under the self-updated pnpm'
|
||||||
|
# If the bug recurs, the previous step's run_install will have failed
|
||||||
|
# the job with "Unknown option: 'runtime'", so reaching this step
|
||||||
|
# implies success. Still verify the version on PATH matches request.
|
||||||
|
env:
|
||||||
|
REQUIRED: '11.1.0'
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
actual="$(pnpm --version)"
|
||||||
|
echo "pnpm --version: ${actual}"
|
||||||
|
if [ "${actual}" != "${REQUIRED}" ]; then
|
||||||
|
echo "Expected pnpm ${REQUIRED}, got ${actual}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
shell: bash
|
||||||
|
|
||||||
|
cache_store_path:
|
||||||
|
# Regression guard for #233. When package.json pins a pnpm major that
|
||||||
|
# differs from the bootstrap pnpm's major, the bootstrap reports its
|
||||||
|
# own STORE_VERSION from `pnpm store path` (the `store` command skips
|
||||||
|
# pnpm's auto-switch). The user's actual `pnpm install` runs under the
|
||||||
|
# pinned version and writes to a different STORE_VERSION, so the post
|
||||||
|
# step's saveCache then fails with "Path Validation Error". The fix is
|
||||||
|
# to self-update the bootstrap to the pinned version up front.
|
||||||
|
name: 'Cache store path matches install (#233): ${{ matrix.label }}'
|
||||||
|
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- label: 'packageManager pnpm@10.33.0'
|
||||||
|
manifest: '{"packageManager":"pnpm@10.33.0","dependencies":{"is-odd":"3.0.1"}}'
|
||||||
|
- label: 'devEngines exact pnpm@10.33.0'
|
||||||
|
manifest: '{"devEngines":{"packageManager":{"name":"pnpm","version":"10.33.0"}},"dependencies":{"is-odd":"3.0.1"}}'
|
||||||
|
- label: 'devEngines range >=10 <11'
|
||||||
|
manifest: '{"devEngines":{"packageManager":{"name":"pnpm","version":">=10 <11"}},"dependencies":{"is-odd":"3.0.1"}}'
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
|
||||||
|
|
||||||
|
- name: Set up package.json
|
||||||
|
run: echo '${{ matrix.manifest }}' > package.json
|
||||||
|
shell: bash
|
||||||
|
|
||||||
|
- id: pnpm
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
cache: true
|
||||||
|
run_install: |
|
||||||
|
- args: [--no-frozen-lockfile]
|
||||||
|
|
||||||
|
- name: 'Test: store path computed by the action exists on disk'
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
actual="$(pnpm store path --silent)"
|
||||||
|
echo "pnpm store path: ${actual}"
|
||||||
|
if [ ! -d "${actual}" ]; then
|
||||||
|
echo "Expected store path to exist on disk; cache save would fail"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
shell: bash
|
||||||
|
|
||||||
run_install:
|
run_install:
|
||||||
name: 'run_install (${{ matrix.run_install.name }})'
|
name: 'run_install (${{ matrix.run_install.name }})'
|
||||||
|
|
||||||
|
|||||||
258
dist/index.js
vendored
258
dist/index.js
vendored
File diff suppressed because one or more lines are too long
@@ -84,37 +84,31 @@ export async function runSelfInstaller(inputs: Inputs): Promise<SelfInstallerRes
|
|||||||
? path.join(dest, 'node_modules', '@pnpm', 'exe', process.platform === 'win32' ? 'pnpm.exe' : 'pnpm')
|
? path.join(dest, 'node_modules', '@pnpm', 'exe', process.platform === 'win32' ? 'pnpm.exe' : 'pnpm')
|
||||||
: path.join(dest, 'node_modules', 'pnpm', 'bin', 'pnpm.mjs')
|
: path.join(dest, 'node_modules', 'pnpm', 'bin', 'pnpm.mjs')
|
||||||
|
|
||||||
// Determine the target version
|
// Self-update the bootstrap to the requested pnpm version. readTargetVersion
|
||||||
|
// either returns a value or throws, so this always runs.
|
||||||
const targetVersion = readTargetVersion({ version, packageJsonFile })
|
const targetVersion = readTargetVersion({ version, packageJsonFile })
|
||||||
|
const cmd = standalone ? bootstrapPnpm : process.execPath
|
||||||
if (targetVersion) {
|
const args = standalone ? ['self-update', targetVersion] : [bootstrapPnpm, 'self-update', targetVersion]
|
||||||
const cmd = standalone ? bootstrapPnpm : process.execPath
|
const exitCode = await runCommand(cmd, args, { cwd: dest })
|
||||||
const args = standalone ? ['self-update', targetVersion] : [bootstrapPnpm, 'self-update', targetVersion]
|
if (exitCode !== 0) {
|
||||||
const exitCode = await runCommand(cmd, args, { cwd: dest })
|
return { exitCode, binDest: pnpmHome }
|
||||||
if (exitCode !== 0) {
|
|
||||||
return { exitCode, binDest: pnpmHome }
|
|
||||||
}
|
|
||||||
// self-update writes the target pnpm/pnpx into PNPM_HOME/bin, leaving
|
|
||||||
// the bootstrap symlinks in pnpmHome pointing at the old version. Use
|
|
||||||
// PNPM_HOME/bin so consumers of the bin_dest output (e.g.
|
|
||||||
// `${steps.pnpm.outputs.bin_dest}/pnpm`) invoke the requested version.
|
|
||||||
return { exitCode: 0, binDest: path.join(pnpmHome, 'bin') }
|
|
||||||
}
|
}
|
||||||
|
// self-update writes the target pnpm/pnpx into PNPM_HOME/bin, leaving
|
||||||
// No explicit target version: rely on the bootstrap pnpm to switch to
|
// the bootstrap symlinks in pnpmHome pointing at the old version. Use
|
||||||
// the version declared in packageManager/devEngines at runtime. Force
|
// PNPM_HOME/bin so consumers of the bin_dest output (e.g.
|
||||||
// `pmOnFail=download` so a project that pins
|
// `${steps.pnpm.outputs.bin_dest}/pnpm`) invoke the requested version.
|
||||||
// `devEngines.packageManager.onFail = "error"` doesn't trip BAD_PM_VERSION
|
//
|
||||||
// before the switch can happen (issue #252). Scoped to this branch so users
|
// When the requested version resolves to the bootstrap version, self-update
|
||||||
// who pass an explicit `version:` input keep strict onFail behavior.
|
// is a no-op and PNPM_HOME/bin is not created — fall back to pnpmHome,
|
||||||
exportVariable('pnpm_config_pm_on_fail', 'download')
|
// whose symlinks already point at the right version.
|
||||||
return { exitCode: 0, binDest: pnpmHome }
|
const updatedBinDir = path.join(pnpmHome, 'bin')
|
||||||
|
return { exitCode: 0, binDest: existsSync(updatedBinDir) ? updatedBinDir : pnpmHome }
|
||||||
}
|
}
|
||||||
|
|
||||||
function readTargetVersion(opts: {
|
function readTargetVersion(opts: {
|
||||||
readonly version?: string | undefined
|
readonly version?: string | undefined
|
||||||
readonly packageJsonFile: string
|
readonly packageJsonFile: string
|
||||||
}): string | undefined {
|
}): string {
|
||||||
const { version, packageJsonFile } = opts
|
const { version, packageJsonFile } = opts
|
||||||
const { GITHUB_WORKSPACE } = process.env
|
const { GITHUB_WORKSPACE } = process.env
|
||||||
|
|
||||||
@@ -135,12 +129,15 @@ function readTargetVersion(opts: {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// packageManager is always exact `pnpm@<version>[+<integrity>]` per spec.
|
||||||
|
// Strip the integrity hash for self-update.
|
||||||
|
const packageManagerVersion =
|
||||||
|
typeof packageManager === 'string' && packageManager.startsWith('pnpm@')
|
||||||
|
? packageManager.slice('pnpm@'.length).split('+')[0]
|
||||||
|
: undefined
|
||||||
|
|
||||||
if (version) {
|
if (version) {
|
||||||
if (
|
if (packageManagerVersion && packageManagerVersion !== version) {
|
||||||
typeof packageManager === 'string' &&
|
|
||||||
packageManager.startsWith('pnpm@') &&
|
|
||||||
packageManager.replace('pnpm@', '') !== version
|
|
||||||
) {
|
|
||||||
throw new Error(`Multiple versions of pnpm specified:
|
throw new Error(`Multiple versions of pnpm specified:
|
||||||
- version ${version} in the GitHub Action config with the key "version"
|
- version ${version} in the GitHub Action config with the key "version"
|
||||||
- version ${packageManager} in the package.json with the key "packageManager"
|
- version ${packageManager} in the package.json with the key "packageManager"
|
||||||
@@ -150,13 +147,22 @@ Remove one of these versions to avoid version mismatch errors like ERR_PNPM_BAD_
|
|||||||
return version
|
return version
|
||||||
}
|
}
|
||||||
|
|
||||||
// pnpm will automatically download and switch to the right version
|
// Self-update the bootstrap pnpm to the version pinned in package.json so
|
||||||
if (typeof packageManager === 'string' && packageManager.startsWith('pnpm@')) {
|
// PATH-resolved `pnpm` (and the bin_dest output) reflect the target
|
||||||
return undefined
|
// version. Without this, `pnpm store path` runs as the bootstrap and
|
||||||
|
// reports a different STORE_VERSION than the one the user's actual
|
||||||
|
// install writes to — breaking cache: true and actions/setup-node's
|
||||||
|
// `cache: pnpm` on cold caches (issue #233).
|
||||||
|
//
|
||||||
|
// devEngines.packageManager takes priority over packageManager, matching
|
||||||
|
// pnpm's getWantedPackageManager logic. `pnpm self-update` accepts both
|
||||||
|
// exact versions and semver ranges, so we pass either through directly.
|
||||||
|
if (devEngines?.packageManager?.name === 'pnpm' && devEngines.packageManager.version) {
|
||||||
|
return devEngines.packageManager.version
|
||||||
}
|
}
|
||||||
|
|
||||||
if (devEngines?.packageManager?.name === 'pnpm' && devEngines.packageManager.version) {
|
if (packageManagerVersion) {
|
||||||
return undefined
|
return packageManagerVersion
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!GITHUB_WORKSPACE) {
|
if (!GITHUB_WORKSPACE) {
|
||||||
|
|||||||
@@ -1,11 +1,8 @@
|
|||||||
import { setFailed, startGroup, endGroup } from '@actions/core'
|
import { setFailed, startGroup, endGroup } from '@actions/core'
|
||||||
import { spawnSync } from 'child_process'
|
import { spawnSync } from 'child_process'
|
||||||
import { Inputs } from '../inputs'
|
import { Inputs } from '../inputs'
|
||||||
import { patchPnpmEnv } from '../utils'
|
|
||||||
|
|
||||||
export function runPnpmInstall(inputs: Inputs) {
|
export function runPnpmInstall(inputs: Inputs) {
|
||||||
const env = patchPnpmEnv(inputs)
|
|
||||||
|
|
||||||
for (const options of inputs.runInstall) {
|
for (const options of inputs.runInstall) {
|
||||||
const args = ['install']
|
const args = ['install']
|
||||||
if (options.recursive) args.unshift('recursive')
|
if (options.recursive) args.unshift('recursive')
|
||||||
@@ -14,11 +11,16 @@ export function runPnpmInstall(inputs: Inputs) {
|
|||||||
const cmdStr = ['pnpm', ...args].join(' ')
|
const cmdStr = ['pnpm', ...args].join(' ')
|
||||||
startGroup(`Running ${cmdStr}...`)
|
startGroup(`Running ${cmdStr}...`)
|
||||||
|
|
||||||
|
// spawnSync inherits process.env, which already has $PNPM_HOME/bin and
|
||||||
|
// $PNPM_HOME prepended via addPath() in install-pnpm. Do NOT pass a
|
||||||
|
// hand-patched env that adds node_modules/.bin to the front — on
|
||||||
|
// Windows standalone, .bin/pnpm.cmd is an npm shim pointing at the
|
||||||
|
// BOOTSTRAP pnpm, which would shadow the self-updated one and break
|
||||||
|
// newer-pnpm-only behavior.
|
||||||
const { error, status } = spawnSync('pnpm', args, {
|
const { error, status } = spawnSync('pnpm', args, {
|
||||||
stdio: 'inherit',
|
stdio: 'inherit',
|
||||||
cwd: options.cwd,
|
cwd: options.cwd,
|
||||||
shell: true,
|
shell: true,
|
||||||
env,
|
|
||||||
})
|
})
|
||||||
|
|
||||||
endGroup()
|
endGroup()
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
import { warning, startGroup, endGroup } from '@actions/core'
|
import { warning, startGroup, endGroup } from '@actions/core'
|
||||||
import { spawnSync } from 'child_process'
|
import { spawnSync } from 'child_process'
|
||||||
import { Inputs } from '../inputs'
|
import { Inputs } from '../inputs'
|
||||||
import { patchPnpmEnv } from '../utils'
|
|
||||||
|
|
||||||
export function pruneStore(inputs: Inputs) {
|
export function pruneStore(inputs: Inputs) {
|
||||||
if (inputs.runInstall.length === 0) {
|
if (inputs.runInstall.length === 0) {
|
||||||
@@ -10,10 +9,11 @@ export function pruneStore(inputs: Inputs) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
startGroup('Running pnpm store prune...')
|
startGroup('Running pnpm store prune...')
|
||||||
|
// spawnSync inherits process.env (which has the right PATH from addPath
|
||||||
|
// in install-pnpm). See pnpm-install/index.ts for the rationale.
|
||||||
const { error, status } = spawnSync('pnpm', ['store', 'prune'], {
|
const { error, status } = spawnSync('pnpm', ['store', 'prune'], {
|
||||||
stdio: 'inherit',
|
stdio: 'inherit',
|
||||||
shell: true,
|
shell: true,
|
||||||
env: patchPnpmEnv(inputs),
|
|
||||||
})
|
})
|
||||||
endGroup()
|
endGroup()
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +0,0 @@
|
|||||||
import path from 'path'
|
|
||||||
import process from 'process'
|
|
||||||
import { Inputs } from '../inputs'
|
|
||||||
|
|
||||||
export const getBinDest = (inputs: Inputs): string => path.join(inputs.dest, 'node_modules', '.bin')
|
|
||||||
|
|
||||||
export const patchPnpmEnv = (inputs: Inputs): NodeJS.ProcessEnv => ({
|
|
||||||
...process.env,
|
|
||||||
PATH: path.join(getBinDest(inputs), 'bin') + path.delimiter + getBinDest(inputs) + path.delimiter + process.env.PATH,
|
|
||||||
})
|
|
||||||
Reference in New Issue
Block a user