Skip to content

Commit fbda4c8

Browse files
committed
docs(README): update version
1 parent c868a7d commit fbda4c8

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Install pnpm **and** a JavaScript runtime (Node.js, Bun, or Deno) in a single Gi
55
pnpm ships a self-contained release binary — the action downloads it for the runner's platform from the npm registry, refusing anything whose npm signature or checksum does not check out (no Node.js or npm needed) and then uses `pnpm runtime set` to install the requested runtime. The runtime binary is placed on `PATH` for subsequent steps, replacing the need for `actions/setup-node`, `oven-sh/setup-bun`, or `denoland/setup-deno`. `pnpm install` runs automatically when a `package.json` is present.
66

77
> [!NOTE]
8-
> `pnpm/setup@v2` installs pnpm v11 and newer only — it relies on pnpm's self-contained release binaries and the `pnpm runtime` command, both available from v11. `v1` installed pnpm through npm and could set up pnpm 10; if you need pnpm 10 or older, use [`pnpm/action-setup`](https://github.com/pnpm/action-setup) instead.
8+
> `pnpm/setup@v3` installs pnpm v11 and newer only — it relies on pnpm's self-contained release binaries and the `pnpm runtime` command, both available from v11. `v1` installed pnpm through npm and could set up pnpm 10; if you need pnpm 10 or older, use [`pnpm/action-setup`](https://github.com/pnpm/action-setup) instead.
99
>
1010
> One caveat: pnpm v11 publishes no binary for Intel macOS (`darwin-x64`); use v12 or newer on Intel macOS runners.
1111
@@ -64,7 +64,7 @@ jobs:
6464
runs-on: ubuntu-latest
6565
steps:
6666
- uses: actions/checkout@v7
67-
- uses: pnpm/setup@v2
67+
- uses: pnpm/setup@v3
6868
- run: node --version
6969
- run: pnpm test
7070
```
@@ -77,7 +77,7 @@ With a `.node-version`, `.nvmrc`, or Node.js entry in `.tool-versions` in the
7777
project directory, no runtime input is needed:
7878

7979
```yaml
80-
- uses: pnpm/setup@v2
80+
- uses: pnpm/setup@v3
8181
```
8282

8383
Node.js version selection uses this precedence:
@@ -96,15 +96,15 @@ another file. If no version source exists, Node.js is not installed unless
9696
To use a different file:
9797

9898
```yaml
99-
- uses: pnpm/setup@v2
99+
- uses: pnpm/setup@v3
100100
with:
101101
node-version-file: config/node-version
102102
```
103103

104104
To disable version-file detection:
105105

106106
```yaml
107-
- uses: pnpm/setup@v2
107+
- uses: pnpm/setup@v3
108108
with:
109109
node-version-file: false
110110
```
@@ -133,7 +133,7 @@ jobs:
133133
node: [22, 24, 26]
134134
steps:
135135
- uses: actions/checkout@v7
136-
- uses: pnpm/setup@v2
136+
- uses: pnpm/setup@v3
137137
with:
138138
runtime: node@${{ matrix.node }}
139139
- run: pnpm test
@@ -142,11 +142,11 @@ jobs:
142142
### Install Bun or Deno
143143

144144
```yaml
145-
- uses: pnpm/setup@v2
145+
- uses: pnpm/setup@v3
146146
with:
147147
runtime: bun@latest
148148
149-
- uses: pnpm/setup@v2
149+
- uses: pnpm/setup@v3
150150
with:
151151
runtime: deno@2
152152
```
@@ -157,7 +157,7 @@ When the project is not at the repository root — a site in `docs/`, an app in
157157
`web/` — point the action at it:
158158

159159
```yaml
160-
- uses: pnpm/setup@v2
160+
- uses: pnpm/setup@v3
161161
with:
162162
working-directory: docs
163163
cache: true
@@ -180,7 +180,7 @@ the project's own root is not the repository root.
180180
### Cache the pnpm store
181181

182182
```yaml
183-
- uses: pnpm/setup@v2
183+
- uses: pnpm/setup@v3
184184
with:
185185
cache: true
186186
```
@@ -234,7 +234,7 @@ known to be complete. The record count cannot be bounded there, so only the
234234
### Require a lockfile
235235

236236
```yaml
237-
- uses: pnpm/setup@v2
237+
- uses: pnpm/setup@v3
238238
with:
239239
require-lockfile: true
240240
```
@@ -278,7 +278,7 @@ and tokens together. Use YAML's `|` block to keep the JSON readable. For
278278
example, to install `@myorg/*` packages from GitHub Packages:
279279

280280
```yaml
281-
- uses: pnpm/setup@v2
281+
- uses: pnpm/setup@v3
282282
env:
283283
pnpm_config__auth: |
284284
{
@@ -294,7 +294,7 @@ Use `"@"` for a registry-wide default token. This also selects that URL as the
294294
default registry:
295295

296296
```yaml
297-
- uses: pnpm/setup@v2
297+
- uses: pnpm/setup@v3
298298
env:
299299
pnpm_config__auth: |
300300
{
@@ -319,7 +319,7 @@ See pnpm's [`_auth` documentation](https://pnpm.io/npmrc#_auth) for details.
319319
For jobs that only need pnpm itself — e.g. `pnpm audit`, lockfile-only regeneration — set `install: false`:
320320

321321
```yaml
322-
- uses: pnpm/setup@v2
322+
- uses: pnpm/setup@v3
323323
with:
324324
install: false
325325
- run: pnpm audit
@@ -339,7 +339,7 @@ pnpm 12 links global runtime bins as context-aware shims: running `node` inside
339339
So whenever the action installs a runtime, it exports `PNPM_CONFIG_GLOBAL_SHIMS` with that runtime disabled (`{"node":false}`), leaving every other runtime at pnpm's defaults. To keep the switching behaviour, set the variable yourself — the action never overwrites a value the workflow already provides:
340340

341341
```yaml
342-
- uses: pnpm/setup@v2
342+
- uses: pnpm/setup@v3
343343
env:
344344
PNPM_CONFIG_GLOBAL_SHIMS: '{"node":"auto"}'
345345
with:

0 commit comments

Comments
 (0)