setup/action.yml at main · pnpm/setup · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
name: Setup pnpm with runtime
description: Install pnpm and a JavaScript runtime (Node.js, Bun, or Deno) in one step
branding:
  icon: package
  color: orange
inputs:
  version:
    description: Version of pnpm to install
    required: false
  dest:
    description: Where to store pnpm files
    required: false
    default: ~/setup-pnpm
  runtime:
    description: |
      Runtime to install, in `<name>` or `<name>@<version>` form (matching
      pnpm's `packageManager` field syntax). Supported names: `node`, `bun`,
      `deno`. Examples: `node@22`, `node@lts`, `node@^24.4.0`, `bun@latest`,
      `deno@2`.

      When the version is omitted, the action falls back to the version
      declared in `devEngines.runtime` for the same name, or to `lts` (for
      `node`) / `latest` for others.

      If this input is omitted entirely, the action reads `devEngines.runtime`
      from the project's package.json. If that is also missing, no runtime is
      installed.
    required: false
  cache:
    description: Whether to cache the pnpm store directory
    required: false
    default: 'false'
  cache-dependency-path:
    description: File path to the pnpm lockfile, which contents hash will be used as a cache key
    required: false
    default: 'pnpm-lock.yaml'
  package-json-file:
    description: File path to the package.json to read `packageManager` and `devEngines.runtime` configuration. This path must be relative to the repository root (GITHUB_WORKSPACE).
    required: false
    default: 'package.json'
  install:
    description: |
      Whether to run `pnpm install` after pnpm and the runtime are set up.

      When set to `true` (the default), the action runs `pnpm install` in the
      workspace when a package.json is present. When the `runtime` input is
      also set, `--no-runtime` is appended automatically so the installed
      runtime isn't shadowed by a different version declared in
      `devEngines.runtime`.

      Set to `false` to skip the install step — useful for jobs that only
      need pnpm itself (e.g. `pnpm audit`, lockfile-only regeneration).
    required: false
    default: 'true'
outputs:
  dest:
    description: Expanded path of inputs#dest
  bin-dest:
    description: Location of `pnpm` and `pnpx` command
  runtime-name:
    description: Name of the installed runtime (`node`, `bun`, or `deno`), or empty if none was installed
  runtime-version:
    description: Resolved version of the installed runtime, or empty if none was installed
runs:
  using: node24
  main: dist/index.js
  post: dist/index.js