docs: change order of setup node and pnpm (#129)

* Throw error when multiple versions specified

* fix: fmt

* fix: fmt

* Swallow error on ENOENT

* Match versions

* refactor: install pnpm

---------

Co-authored-by: Khải <hvksmr1996@gmail.com>
Co-authored-by: Zoltan Kochan <z@kochan.io>

.github/FUNDING.yml

@@ -1,12 +1,2 @@
-# These are supported funding model platforms
+custom:
-
+  - https://opencollective.com/pnpm
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: khai96_
-open_collective: # Collective unavailable
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # disabled
-otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/dependabot.yml

@@ -5,6 +5,3 @@ updates:
     schedule:
       interval: weekly
     open-pull-requests-limit: 10
-    labels:
-    - dependabot
-    - github-actions

.github/workflows/test.yaml

@@ -22,7 +22,7 @@ jobs:
           - windows-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Run the action
         uses: ./
@@ -35,8 +35,8 @@ jobs:
       - name: 'Test: install'
         run: pnpm install
 
-  test_explicit_inputs:
+  test_dest:
-    name: Test with explicit inputs
+    name: Test with dest
 
     runs-on: ${{ matrix.os }}
 
@@ -51,7 +51,7 @@ jobs:
           - windows-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Run the action
         uses: ./
@@ -65,6 +65,61 @@ jobs:
       - name: 'Test: install'
         run: pnpm install
 
+  test_standalone:
+    name: Test with standalone
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+
+        standalone:
+          - true
+          - false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run the action
+        uses: ./
+        with:
+          version: 7.0.0
+          standalone: ${{ matrix.standalone }}
+
+      - name: install Node.js
+        uses: actions/setup-node@v4
+        with:
+          # pnpm@7.0.0 is not compatible with Node.js 12
+          node-version: 12.22.12
+
+      - name: 'Test: which (pnpm)'
+        run: which pnpm
+
+      - name: 'Test: which (pnpx)'
+        if: matrix.standalone == false
+        run: which pnpx
+
+      - name: 'Test: install when standalone is true'
+        if: matrix.standalone
+        run: pnpm install
+
+      - name: 'Test: install when standalone is false'
+        if: matrix.standalone == false
+        # Since the default shell on windows runner is pwsh, we specify bash explicitly
+        shell: bash
+        run: |
+          if pnpm install; then
+            echo "pnpm install should fail"
+            exit 1
+          else
+            echo "pnpm install failed as expected"
+          fi
+
   test_run_install:
     name: 'Test with run_install (${{ matrix.run_install.name }}, ${{ matrix.os }})'
 
@@ -107,7 +162,7 @@ jobs:
                 - pnpm
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Run the action
         uses: ./

.gitignore

@@ -2,6 +2,8 @@ node_modules
 *.log
 /dist/*
 !/dist/index.js
+!/dist/pnpm.cjs
+!/dist/worker.js
 tmp
 temp
 *.tmp

README.md

@@ -1,16 +1,20 @@
-# Setup PNPM
+# Setup pnpm
 
-Install PNPM package manager.
+Install pnpm package manager.
 
 ## Inputs
 
 ### `version`
 
-**Required** Version of PNPM to install.
+Version of pnpm to install.
+
+**Optional** when there is a [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html).
+
+otherwise, this field is **required** It supports npm versioning scheme, it could be an exact version (such as `6.24.1`), or a version range (such as `6`, `6.x.x`, `6.24.x`, `^6.24.1`, `*`, etc.), or `latest`.
 
 ### `dest`
 
-**Optional** Where to store PNPM files.
+**Optional** Where to store pnpm files.
 
 ### `run_install`
 
@@ -34,6 +38,16 @@ If `run_install` is a YAML string representation of either an object or an array
 
 **Optional** (_type:_ `string[]`) Additional arguments after `pnpm [recursive] install`, e.g. `[--frozen-lockfile, --strict-peer-dependencies]`.
 
+### `package_json_file`
+
+**Optional** (_type:_ `string`, _default:_ `package.json`) File path to the `package.json` to read "packageManager" configuration.
+
+### `standalone`
+
+**Optional** (_type:_ `boolean`, _default:_ `false`) When set to true, [@pnpm/exe](https://www.npmjs.com/package/@pnpm/exe), which is a Node.js bundled package, will be installed, enabling using `pnpm` without Node.js.
+
+This is useful when you want to use a incompatible pair of Node.js and pnpm.
+
 ## Outputs
 
 ### `dest`
@@ -46,7 +60,7 @@ Location of `pnpm` and `pnpx` command.
 
 ## Usage example
 
-### Just install PNPM
+### Just install pnpm
 
 ```yaml
 on:
@@ -54,15 +68,16 @@ on:
   - pull_request
 
 jobs:
-  runs-on: ubuntu-latest
+  install:
+    runs-on: ubuntu-latest
 
-  steps:
+    steps:
-    - uses: pnpm/action-setup@v1.2.1
+      - uses: pnpm/action-setup@v4
-      with:
+        with:
-        version: 5.17.2
+          version: 8
 ```
 
-### Install PNPM and a few NPM packages
+### Install pnpm and a few npm packages
 
 ```yaml
 on:
@@ -70,18 +85,19 @@ on:
   - pull_request
 
 jobs:
-  runs-on: ubuntu-latest
+  install:
+    runs-on: ubuntu-latest
 
-  steps:
+    steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-    - uses: pnpm/action-setup@v1.2.1
+      - uses: pnpm/action-setup@v4
-      with:
+        with:
-        version: 5.17.2
+          version: 8
-        run_install: |
+          run_install: |
-          - recursive: true
+            - recursive: true
-            args: [--frozen-lockfile, --strict-peer-dependencies]
+              args: [--frozen-lockfile, --strict-peer-dependencies]
-          - args: [--global, gulp, prettier, typescript]
+            - args: [--global, gulp, prettier, typescript]
 ```
 
 ### Use cache to reduce installation time
@@ -92,26 +108,40 @@ on:
   - pull_request
 
 jobs:
-  runs-on: ubuntu-latest
+  cache-and-install:
+    runs-on: ubuntu-latest
 
-  steps:
+    steps:
-    build:
+      - name: Checkout
-      - uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
-      - name: Cache pnpm modules
+      - uses: pnpm/action-setup@v4
-        uses: actions/cache@v2
+        name: Install pnpm
-        env:
-          cache-name: cache-pnpm-modules
         with:
-          path: ~/.pnpm-store
+          version: 8
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ matrix.node-version }}-${{ hashFiles('**/package.json') }}
+          run_install: false
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
           restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-${{ matrix.node-version }}-
+            ${{ runner.os }}-pnpm-store-
 
-      - uses: pnpm/action-setup@v1.2.1
+      - name: Install dependencies
-        with:
+        run: pnpm install
-          version: 5.17.2
-          run_install: true
 ```
 
 **Note:** You don't need to run `pnpm store prune` at the end; post-action has already taken care of that.
@@ -122,4 +152,4 @@ This action does not setup Node.js for you, use [actions/setup-node](https://git
 
 ## License
 
-[MIT](https://git.io/JfclH) © [Hoàng Văn Khải](https://github.com/KSXGitHub/)
+[MIT](https://github.com/pnpm/action-setup/blob/master/LICENSE.md) © [Hoàng Văn Khải](https://github.com/KSXGitHub/)

action.yml

@@ -1,21 +1,34 @@
-name: Setup PNPM
+name: Setup pnpm
-description: Install PNPM package manager
+description: Install pnpm package manager
 branding:
   icon: package
   color: orange
 inputs:
   version:
-    description: Version of PNPM to install
+    description: Version of pnpm to install
-    required: true
+    required: false
   dest:
-    description: Where to store PNPM files
+    description: Where to store pnpm files
     required: false
     default: ~/setup-pnpm
   run_install:
     description: If specified, run `pnpm install`
     required: false
     default: 'null'
+  package_json_file:
+    description: File path to the package.json to read "packageManager" configuration
+    required: false
+    default: 'package.json'
+  standalone:
+    description: When set to true, @pnpm/exe, which is a Node.js bundled package, will be installed, enabling using pnpm without Node.js.
+    required: false
+    default: 'false'
+outputs:
+  dest:
+    description: Expanded path of inputs#dest
+  bin_dest:
+    description: Location of `pnpm` and `pnpx` command
 runs:
-  using: node12
+  using: node20
   main: dist/index.js
   post: dist/index.js

package.json

@@ -1,27 +1,23 @@
 {
   "private": true,
   "scripts": {
-    "build:schemas": "ts-schema-autogen generate",
     "build:ncc": "ncc build --minify --no-source-map-register --no-cache dist/tsc/index.js --out dist/",
-    "build": "pnpm run build:schemas && tsc && pnpm run build:ncc",
+    "build": "tsc && pnpm run build:ncc",
-    "start": "pnpm run build && sh ./run.sh"
+    "start": "pnpm run build && sh ./run.sh",
+    "update-pnpm-dist": "pnpm install && cp ./node_modules/pnpm/dist/pnpm.cjs ./dist/pnpm.cjs && cp ./node_modules/pnpm/dist/worker.js ./dist/worker.js"
   },
   "dependencies": {
-    "node-fetch": "^2.6.1",
+    "@actions/core": "^1.10.1",
+    "@types/expand-tilde": "^2.0.2",
+    "@types/node": "^20.11.5",
+    "@types/node-fetch": "^2.6.11",
     "expand-tilde": "^2.0.2",
-    "js-yaml": "^4.0.0",
+    "yaml": "^2.3.4",
-    "ajv": "^6.12.5",
+    "zod": "^3.22.4"
-    "fs-extra": "^9.1.0",
-    "@actions/core": "^1.2.6",
-    "@types/expand-tilde": "^2.0.0",
-    "@types/node-fetch": "^2.5.8",
-    "@types/js-yaml": "^4.0.0",
-    "@types/fs-extra": "^9.0.8",
-    "@types/node": "^14.14.35"
   },
   "devDependencies": {
-    "typescript": "^4.2.3",
+    "@vercel/ncc": "^0.38.1",
-    "@ts-schema-autogen/cli": "^0.1.2",
+    "pnpm": "^8.14.3",
-    "@vercel/ncc": "^0.27.0"
+    "typescript": "^5.3.3"
   }
 }

run.sh

@@ -4,4 +4,5 @@ export HOME="$(pwd)"
 export INPUT_VERSION=4.11.1
 export INPUT_DEST='~/pnpm.temp'
 export INPUT_RUN_INSTALL=null
+export INPUT_standalone=false
 exec node dist/index.js

src/index.ts

@@ -1,7 +1,7 @@
 import { setFailed, saveState, getState } from '@actions/core'
 import getInputs from './inputs'
-import setOutputs from './outputs'
 import installPnpm from './install-pnpm'
+import setOutputs from './outputs'
 import pnpmInstall from './pnpm-install'
 import pruneStore from './pnpm-store-prune'
 

src/inputs/index.ts

@@ -1,11 +1,13 @@
-import { getInput, InputOptions } from '@actions/core'
+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 version?: string
   readonly dest: string
   readonly runInstall: RunInstall[]
+  readonly packageJsonFile: string
+  readonly standalone: boolean
 }
 
 const options: InputOptions = {
@@ -15,9 +17,11 @@ const options: InputOptions = {
 const parseInputPath = (name: string) => expandTilde(getInput(name, options))
 
 export const getInputs = (): Inputs => ({
-  version: getInput('version', options),
+  version: getInput('version'),
   dest: parseInputPath('dest'),
   runInstall: parseRunInstall('run_install'),
+  packageJsonFile: parseInputPath('package_json_file'),
+  standalone: getBooleanInput('standalone'),
 })
 
 export default getInputs

src/inputs/run-install-input.schema.autogen.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "https://raw.githubusercontent.com/ksxnodeapps/ts-schema-autogen/master/packages/schemas/config.schema.json",
-  "instruction": {
-    "compilerOptions": {
-      "strict": true,
-      "target": "ES2018",
-      "lib": [
-        "ES2018",
-        "ES2019",
-        "ES2020",
-        "ESNext"
-      ],
-      "moduleResolution": "Node",
-      "esModuleInterop": true,
-      "resolveJsonModule": true
-    },
-    "input": "run-install.ts",
-    "symbol": "RunInstallInput",
-    "output": "run-install-input.schema.json"
-  }
-}

src/inputs/run-install-input.schema.json

@@ -1,39 +0,0 @@
-{
-  "anyOf": [
-    {
-      "$ref": "#/definitions/RunInstall"
-    },
-    {
-      "type": "array",
-      "items": {
-        "$ref": "#/definitions/RunInstall"
-      }
-    },
-    {
-      "type": [
-        "null",
-        "boolean"
-      ]
-    }
-  ],
-  "definitions": {
-    "RunInstall": {
-      "type": "object",
-      "properties": {
-        "recursive": {
-          "type": "boolean"
-        },
-        "cwd": {
-          "type": "string"
-        },
-        "args": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        }
-      }
-    }
-  },
-  "$schema": "http://json-schema.org/draft-07/schema#"
-}

src/inputs/run-install.ts

@@ -1,39 +1,41 @@
-import process from 'process'
+import { getInput, error } from '@actions/core'
-import { load } from 'js-yaml'
+import * as yaml from 'yaml'
-import Ajv from 'ajv'
+import { z, ZodError } from 'zod'
-import { getInput, error, InputOptions } from '@actions/core'
-import runInstallSchema from './run-install-input.schema.json'
 
-export interface RunInstall {
+const RunInstallSchema = z.object({
-  readonly recursive?: boolean
+  recursive: z.boolean().optional(),
-  readonly cwd?: string
+  cwd: z.string().optional(),
-  readonly args?: readonly string[]
+  args: z.array(z.string()).optional(),
-}
+})
 
-export type RunInstallInput =
+const RunInstallInputSchema = z.union([
-  | null
+  z.null(),
-  | boolean
+  z.boolean(),
-  | RunInstall
+  RunInstallSchema,
-  | RunInstall[]
+  z.array(RunInstallSchema),
+])
 
-const options: InputOptions = {
+export type RunInstallInput = z.infer<typeof RunInstallInputSchema>
-  required: true,
+export type RunInstall = z.infer<typeof RunInstallSchema>
-}
 
-export function parseRunInstall(name: string): RunInstall[] {
+export function parseRunInstall(inputName: string): RunInstall[] {
-  const result: RunInstallInput = load(getInput(name, options)) as any
+  const input = getInput(inputName, { required: true })
-  const ajv = new Ajv({
+  const parsedInput: unknown = yaml.parse(input)
-    allErrors: true,
+
-  })
+  try {
-  const validate = ajv.compile(runInstallSchema)
+    const result: RunInstallInput = RunInstallInputSchema.parse(parsedInput)
-  if (!validate(result)) {
+    if (!result) return []
-    for (const errorItem of validate.errors!) {
+    if (result === true) return [{ recursive: true }]
-      error(`with.run_install${errorItem.dataPath}: ${errorItem.message}`)
+    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}`)
     }
-    return process.exit(1)
+    process.exit(1)
   }
-  if (!result) return []
-  if (result === true) return [{ recursive: true }]
-  if (Array.isArray(result)) return result
-  return [result]
 }

src/install-pnpm/index.ts

@@ -9,7 +9,7 @@ export async function install(inputs: Inputs) {
   const status = await runSelfInstaller(inputs)
   endGroup()
   if (status) {
-    return setFailed(`Something does wrong, self-installer exits with code ${status}`)
+    return setFailed(`Something went wrong, self-installer exits with code ${status}`)
   }
 }
 

src/install-pnpm/run.ts

@@ -1,31 +1,98 @@
+import { addPath, exportVariable } from '@actions/core'
 import { spawn } from 'child_process'
+import { rm, writeFile, mkdir } from 'fs/promises'
+import { readFileSync } from 'fs'
+import path from 'path'
 import { execPath } from 'process'
-import { join } from 'path'
+import util from 'util'
-import { remove, ensureFile, writeFile } from 'fs-extra'
-import fetch from 'node-fetch'
 import { Inputs } from '../inputs'
 
 export async function runSelfInstaller(inputs: Inputs): Promise<number> {
-  const { version, dest } = inputs
+  const { version, dest, packageJsonFile, standalone } = inputs
-  const target = version ? `pnpm@${version}` : 'pnpm'
-  const pkgJson = join(dest, 'package.json')
 
-  await remove(dest)
+  // prepare self install
-  await ensureFile(pkgJson)
+  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 }))
 
-  const cp = spawn(execPath, ['-', 'install', target, '--no-lockfile'], {
+  // 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 response = await fetch('https://pnpm.js.org/pnpm.js')
+  const exitCode = await new Promise<number>((resolve, reject) => {
-  response.body.pipe(cp.stdin)
-
-  return new Promise((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 {
+      ({ packageManager } = JSON.parse(readFileSync(path.join(GITHUB_WORKSPACE, packageJsonFile), 'utf8')))
+    } 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.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/pnpm-install/index.ts

@@ -1,5 +1,5 @@
-import { spawnSync } from 'child_process'
 import { setFailed, startGroup, endGroup } from '@actions/core'
+import { spawnSync } from 'child_process'
 import { Inputs } from '../inputs'
 import { patchPnpmEnv } from '../utils'
 

src/pnpm-store-prune/index.ts

@@ -1,5 +1,5 @@
-import { spawnSync } from 'child_process'
 import { warning, startGroup, endGroup } from '@actions/core'
+import { spawnSync } from 'child_process'
 import { Inputs } from '../inputs'
 import { patchPnpmEnv } from '../utils'
 
@@ -13,7 +13,7 @@ export function pruneStore(inputs: Inputs) {
   const { error, status } = spawnSync('pnpm', ['store', 'prune'], {
     stdio: 'inherit',
     shell: true,
-    env: patchPnpmEnv(inputs)
+    env: patchPnpmEnv(inputs),
   })
   endGroup()
 

src/utils/index.ts

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

tsconfig.json

@@ -1,15 +1,11 @@
 
 {
   "compilerOptions": {
-    "target": "ES2018",
+    "target": "ES2022",
-    "module": "CommonJS",
+    "module": "Node16",
-    "moduleResolution": "Node",
     "resolveJsonModule": true,
     "lib": [
-      "ES2018",
+      "ES2023"
-      "ES2019",
-      "ES2020",
-      "ESNext"
     ],
     "outDir": "./dist/tsc",
     "preserveConstEnums": true,