pnpm/action-setup v4

src/cache-restore/index.ts

@@ -0,0 +1,19 @@
+import { isFeatureAvailable } from '@actions/cache'
+import { endGroup, startGroup, warning } from '@actions/core'
+import { Inputs } from '../inputs'
+import { runRestoreCache } from './run'
+
+export async function restoreCache(inputs: Inputs) {
+  if (!inputs.cache) return
+
+  if (!isFeatureAvailable()) {
+    warning('Cache is not available, skipping cache restoration')
+    return
+  }
+
+  startGroup('Restoring cache...')
+  await runRestoreCache(inputs)
+  endGroup()
+}
+
+export default restoreCache

src/cache-restore/run.ts

@@ -0,0 +1,39 @@
+import { restoreCache } from '@actions/cache'
+import { debug, info, saveState, setOutput } from '@actions/core'
+import { getExecOutput } from '@actions/exec'
+import { hashFiles } from '@actions/glob'
+import os from 'os'
+import { Inputs } from '../inputs'
+
+export async function runRestoreCache(inputs: Inputs) {
+  const cachePath = await getCacheDirectory()
+  saveState('cache_path', cachePath)
+
+  const fileHash = await hashFiles(inputs.cacheDependencyPath)
+  if (!fileHash) {
+    throw new Error('Some specified paths were not resolved, unable to cache dependencies.')
+  }
+
+  const primaryKey = `pnpm-cache-${process.env.RUNNER_OS}-${os.arch()}-${fileHash}`
+  debug(`Primary key is ${primaryKey}`)
+  saveState('cache_primary_key', primaryKey)
+
+  let cacheKey = await restoreCache([cachePath], primaryKey)
+
+  setOutput('cache-hit', Boolean(cacheKey))
+
+  if (!cacheKey) {
+    info(`Cache is not found`)
+    return
+  }
+
+  saveState('cache_restored_key', cacheKey)
+  info(`Cache restored from key: ${cacheKey}`)
+}
+
+async function getCacheDirectory() {
+  const { stdout } = await getExecOutput('pnpm store path --silent')
+  const cacheFolderPath = stdout.trim()
+  debug(`Cache folder is set to "${cacheFolderPath}"`)
+  return cacheFolderPath
+}

src/cache-save/index.ts

@@ -0,0 +1,15 @@
+import { setFailed } from '@actions/core'
+import { Inputs } from '../inputs'
+import { runSaveCache } from './run'
+
+export async function saveCache(inputs: Inputs) {
+  if (!inputs.cache) return
+
+  try {
+    await runSaveCache()
+  } catch (error) {
+    setFailed((error as Error).message)
+  }
+}
+
+export default saveCache

src/cache-save/run.ts

@@ -0,0 +1,18 @@
+import { saveCache } from '@actions/cache'
+import { getState, info } from '@actions/core'
+
+export async function runSaveCache() {
+  const state = getState('cache_restored_key')
+  const primaryKey = getState('cache_primary_key')
+  const cachePath = getState('cache_path')
+
+  if (primaryKey === state) {
+    info(`Cache hit occurred on the primary key ${primaryKey}, not saving cache.`)
+    return
+  }
+
+  const cacheId = await saveCache([cachePath], primaryKey)
+  if (cacheId == -1) return
+
+  info(`Cache saved with the key: ${primaryKey}`)
+}

src/index.ts

@@ -0,0 +1,40 @@
+import { setFailed, saveState, getState } from '@actions/core'
+import restoreCache from './cache-restore'
+import saveCache from './cache-save'
+import getInputs, { Inputs } from './inputs'
+import installPnpm from './install-pnpm'
+import setOutputs from './outputs'
+import pnpmInstall from './pnpm-install'
+import pruneStore from './pnpm-store-prune'
+
+async function main() {
+  const inputs = getInputs()
+
+  if (getState('is_post') === 'true') {
+    await runPost(inputs)
+  } else {
+    await runMain(inputs)
+  }
+}
+
+async function runMain(inputs: Inputs) {
+  saveState('is_post', 'true')
+
+  await installPnpm(inputs)
+  console.log('Installation Completed!')
+  setOutputs(inputs)
+
+  await restoreCache(inputs)
+
+  pnpmInstall(inputs)
+}
+
+async function runPost(inputs: Inputs) {
+  pruneStore(inputs)
+  await saveCache(inputs)
+}
+
+main().catch(error => {
+  console.error(error)
+  setFailed(error)
+})

src/inputs/index.ts

@@ -0,0 +1,31 @@
+import { getBooleanInput, getInput, InputOptions } from '@actions/core'
+import expandTilde from 'expand-tilde'
+import { RunInstall, parseRunInstall } from './run-install'
+
+export interface Inputs {
+  readonly version?: string
+  readonly dest: string
+  readonly cache: boolean
+  readonly cacheDependencyPath: string
+  readonly runInstall: RunInstall[]
+  readonly packageJsonFile: string
+  readonly standalone: boolean
+}
+
+const options: InputOptions = {
+  required: true,
+}
+
+const parseInputPath = (name: string) => expandTilde(getInput(name, options))
+
+export const getInputs = (): Inputs => ({
+  version: getInput('version'),
+  dest: parseInputPath('dest'),
+  cache: getBooleanInput('cache'),
+  cacheDependencyPath: parseInputPath('cache_dependency_path'),
+  runInstall: parseRunInstall('run_install'),
+  packageJsonFile: parseInputPath('package_json_file'),
+  standalone: getBooleanInput('standalone'),
+})
+
+export default getInputs

src/inputs/run-install.ts

@@ -0,0 +1,41 @@
+import { getInput, error } from '@actions/core'
+import { parse as parseYaml } from 'yaml'
+import { z, ZodError } from 'zod'
+
+const RunInstallSchema = z.object({
+  recursive: z.boolean().optional(),
+  cwd: z.string().optional(),
+  args: z.array(z.string()).optional(),
+})
+
+const RunInstallInputSchema = z.union([
+  z.null(),
+  z.boolean(),
+  RunInstallSchema,
+  z.array(RunInstallSchema),
+])
+
+export type RunInstallInput = z.infer<typeof RunInstallInputSchema>
+export type RunInstall = z.infer<typeof RunInstallSchema>
+
+export function parseRunInstall(inputName: string): RunInstall[] {
+  const input = getInput(inputName, { required: true })
+  const parsedInput: unknown = parseYaml(input)
+
+  try {
+    const result: RunInstallInput = RunInstallInputSchema.parse(parsedInput)
+    if (!result) return []
+    if (result === true) return [{ recursive: true }]
+    if (Array.isArray(result)) return result
+    return [result]
+  } catch (exception: unknown) {
+    error(`Error for input "${inputName}" = ${input}`)
+
+    if (exception instanceof ZodError) {
+      error(`Errors: ${exception.errors}`)
+    } else {
+      error(`Exception: ${exception}`)
+    }
+    process.exit(1)
+  }
+}

src/install-pnpm/index.ts

@@ -0,0 +1,16 @@
+import { setFailed, startGroup, endGroup } from '@actions/core'
+import { Inputs } from '../inputs'
+import runSelfInstaller from './run'
+
+export { runSelfInstaller }
+
+export async function install(inputs: Inputs) {
+  startGroup('Running self-installer...')
+  const status = await runSelfInstaller(inputs)
+  endGroup()
+  if (status) {
+    return setFailed(`Something went wrong, self-installer exits with code ${status}`)
+  }
+}
+
+export default install

src/install-pnpm/run.ts

@@ -0,0 +1,115 @@
+import { addPath, exportVariable } from '@actions/core'
+import { spawn } from 'child_process'
+import { rm, writeFile, mkdir, copyFile } from 'fs/promises'
+import { readFileSync } from 'fs'
+import path from 'path'
+import { execPath } from 'process'
+import util from 'util'
+import { Inputs } from '../inputs'
+import { parse as parseYaml } from 'yaml'
+
+export async function runSelfInstaller(inputs: Inputs): Promise<number> {
+  const { version, dest, packageJsonFile, standalone } = inputs
+  const { GITHUB_WORKSPACE } = process.env
+
+  // prepare self install
+  await rm(dest, { recursive: true, force: true })
+  // create dest directory after removal
+  await mkdir(dest, { recursive: true })
+  const pkgJson = path.join(dest, 'package.json')
+  // we have ensured the dest directory exists, we can write the file directly
+  await writeFile(pkgJson, JSON.stringify({ private: true }))
+
+  // copy .npmrc if it exists to install from custom registry
+  if (GITHUB_WORKSPACE) {
+    try {
+      await copyFile(path.join(GITHUB_WORKSPACE, '.npmrc'), path.join(dest, '.npmrc'))
+    } catch (error) {
+      // Swallow error if .npmrc doesn't exist
+      if (!util.types.isNativeError(error) || !('code' in error) || error.code !== 'ENOENT') throw error
+    }
+  }
+
+  // prepare target pnpm
+  const target = await readTarget({ version, packageJsonFile, standalone })
+  const cp = spawn(execPath, [path.join(__dirname, 'pnpm.cjs'), 'install', target, '--no-lockfile'], {
+    cwd: dest,
+    stdio: ['pipe', 'inherit', 'inherit'],
+  })
+
+  const exitCode = await new Promise<number>((resolve, reject) => {
+    cp.on('error', reject)
+    cp.on('close', resolve)
+  })
+  if (exitCode === 0) {
+    const pnpmHome = path.join(dest, 'node_modules/.bin')
+    addPath(pnpmHome)
+    exportVariable('PNPM_HOME', pnpmHome)
+  }
+  return exitCode
+}
+
+async function readTarget(opts: {
+  readonly version?: string | undefined
+  readonly packageJsonFile: string
+  readonly standalone: boolean
+}) {
+  const { version, packageJsonFile, standalone } = opts
+  const { GITHUB_WORKSPACE } = process.env
+
+  let packageManager
+
+  if (GITHUB_WORKSPACE) {
+    try {
+      const content = readFileSync(path.join(GITHUB_WORKSPACE, packageJsonFile), 'utf8');
+      ({ packageManager } = packageJsonFile.endsWith(".yaml")
+        ? parseYaml(content, { merge: true })
+        : JSON.parse(content)
+      )
+    } catch (error: unknown) {
+      // Swallow error if package.json doesn't exist in root
+      if (!util.types.isNativeError(error) || !('code' in error) || error.code !== 'ENOENT') throw error
+    }
+  }
+
+  if (version) {
+    if (
+      typeof packageManager === 'string' &&
+      packageManager.startsWith('pnpm@') &&
+      packageManager.replace('pnpm@', '') !== version
+    ) {
+      throw new Error(`Multiple versions of pnpm specified:
+  - version ${version} in the GitHub Action config with the key "version"
+  - version ${packageManager} in the package.json with the key "packageManager"
+Remove one of these versions to avoid version mismatch errors like ERR_PNPM_BAD_PM_VERSION`)
+    }
+
+    return `${ standalone ? '@pnpm/exe' : 'pnpm' }@${version}`
+  }
+
+  if (!GITHUB_WORKSPACE) {
+    throw new Error(`No workspace is found.
+If you've intended to let pnpm/action-setup read preferred pnpm version from the "packageManager" field in the package.json file,
+please run the actions/checkout before pnpm/action-setup.
+Otherwise, please specify the pnpm version in the action configuration.`)
+  }
+
+  if (typeof packageManager !== 'string') {
+    throw new Error(`No pnpm version is specified.
+Please specify it by one of the following ways:
+  - in the GitHub Action config with the key "version"
+  - in the package.json with the key "packageManager"`)
+  }
+
+  if (!packageManager.startsWith('pnpm@')) {
+    throw new Error('Invalid packageManager field in package.json')
+  }
+
+  if (standalone) {
+    return packageManager.replace('pnpm@', '@pnpm/exe@')
+  }
+
+  return packageManager
+}
+
+export default runSelfInstaller

src/outputs/index.ts

@@ -0,0 +1,12 @@
+import { setOutput, addPath } from '@actions/core'
+import { Inputs } from '../inputs'
+import { getBinDest } from '../utils'
+
+export function setOutputs(inputs: Inputs) {
+  const binDest = getBinDest(inputs)
+  addPath(binDest)
+  setOutput('dest', inputs.dest)
+  setOutput('bin_dest', binDest)
+}
+
+export default setOutputs

src/pnpm-install/index.ts

@@ -0,0 +1,38 @@
+import { setFailed, startGroup, endGroup } from '@actions/core'
+import { spawnSync } from 'child_process'
+import { Inputs } from '../inputs'
+import { patchPnpmEnv } from '../utils'
+
+export function runPnpmInstall(inputs: Inputs) {
+  const env = patchPnpmEnv(inputs)
+
+  for (const options of inputs.runInstall) {
+    const args = ['install']
+    if (options.recursive) args.unshift('recursive')
+    if (options.args) args.push(...options.args)
+
+    const cmdStr = ['pnpm', ...args].join(' ')
+    startGroup(`Running ${cmdStr}...`)
+
+    const { error, status } = spawnSync('pnpm', args, {
+      stdio: 'inherit',
+      cwd: options.cwd,
+      shell: true,
+      env,
+    })
+
+    endGroup()
+
+    if (error) {
+      setFailed(error)
+      continue
+    }
+
+    if (status) {
+      setFailed(`Command ${cmdStr} (cwd: ${options.cwd}) exits with status ${status}`)
+      continue
+    }
+  }
+}
+
+export default runPnpmInstall

src/pnpm-store-prune/index.ts

@@ -0,0 +1,31 @@
+import { warning, startGroup, endGroup } from '@actions/core'
+import { spawnSync } from 'child_process'
+import { Inputs } from '../inputs'
+import { patchPnpmEnv } from '../utils'
+
+export function pruneStore(inputs: Inputs) {
+  if (inputs.runInstall.length === 0) {
+    console.log('Pruning is unnecessary.')
+    return
+  }
+
+  startGroup('Running pnpm store prune...')
+  const { error, status } = spawnSync('pnpm', ['store', 'prune'], {
+    stdio: 'inherit',
+    shell: true,
+    env: patchPnpmEnv(inputs),
+  })
+  endGroup()
+
+  if (error) {
+    warning(error)
+    return
+  }
+
+  if (status) {
+    warning(`command pnpm store prune exits with code ${status}`)
+    return
+  }
+}
+
+export default pruneStore

src/utils/index.ts

@@ -0,0 +1,10 @@
+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: getBinDest(inputs) + path.delimiter + process.env.PATH,
+})