Skip to content

Commit 20d86ab

Browse files
aparnajyothi-yaparnajyothi-y
committed
documentation update
1 parent 191ee32 commit 20d86ab

File tree

2 files changed

+51
-51
lines changed

2 files changed

+51
-51
lines changed

‎README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ See [action.yml](action.yml)
1818

1919
<!-- start usage -->
2020
```yaml
21-
- uses: actions/setup-node@v4
21+
- uses: actions/setup-node@v5
2222
with:
2323
# Version Spec of the version to use in SemVer notation.
2424
# It also admits such aliases as lts/*, latest, nightly and canary builds
@@ -98,8 +98,8 @@ See [action.yml](action.yml)
9898
9999
```yaml
100100
steps:
101-
- uses: actions/checkout@v4
102-
- uses: actions/setup-node@v4
101+
- uses: actions/checkout@v5
102+
- uses: actions/setup-node@v5
103103
with:
104104
node-version: 18
105105
- run: npm ci
@@ -147,8 +147,8 @@ See the examples of using cache for `yarn`/`pnpm` and `cache-dependency-path` in
147147

148148
```yaml
149149
steps:
150-
- uses: actions/checkout@v4
151-
- uses: actions/setup-node@v4
150+
- uses: actions/checkout@v5
151+
- uses: actions/setup-node@v5
152152
with:
153153
node-version: 20
154154
cache: 'npm'
@@ -160,8 +160,8 @@ steps:
160160

161161
```yaml
162162
steps:
163-
- uses: actions/checkout@v4
164-
- uses: actions/setup-node@v4
163+
- uses: actions/checkout@v5
164+
- uses: actions/setup-node@v5
165165
with:
166166
node-version: 20
167167
cache: 'npm'
@@ -181,9 +181,9 @@ jobs:
181181
node: [ 14, 16, 18 ]
182182
name: Node ${{ matrix.node }} sample
183183
steps:
184-
- uses: actions/checkout@v4
184+
- uses: actions/checkout@v5
185185
- name: Setup node
186-
uses: actions/setup-node@v4
186+
uses: actions/setup-node@v5
187187
with:
188188
node-version: ${{ matrix.node }}
189189
- run: npm ci
@@ -197,7 +197,7 @@ jobs:
197197
To get a higher rate limit, you can [generate a personal access token on github.com](https://github.com/settings/tokens/new) and pass it as the `token` input for the action:
198198

199199
```yaml
200-
uses: actions/setup-node@v4
200+
uses: actions/setup-node@v5
201201
with:
202202
token: ${{ secrets.GH_DOTCOM_TOKEN }}
203203
node-version: 20

‎docs/advanced-usage.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ If `check-latest` is set to `true`, the action first checks if the cached versio
4545
4646
```yaml
4747
steps:
48-
- uses: actions/checkout@v4
49-
- uses: actions/setup-node@v4
48+
- uses: actions/checkout@v5
49+
- uses: actions/setup-node@v5
5050
with:
5151
node-version: '16'
5252
check-latest: true
@@ -63,8 +63,8 @@ See [supported version syntax](https://github.com/actions/setup-node#supported-v
6363

6464
```yaml
6565
steps:
66-
- uses: actions/checkout@v4
67-
- uses: actions/setup-node@v4
66+
- uses: actions/checkout@v5
67+
- uses: actions/setup-node@v5
6868
with:
6969
node-version-file: '.nvmrc'
7070
- run: npm ci
@@ -97,8 +97,8 @@ jobs:
9797
runs-on: windows-latest
9898
name: Node sample
9999
steps:
100-
- uses: actions/checkout@v4
101-
- uses: actions/setup-node@v4
100+
- uses: actions/checkout@v5
101+
- uses: actions/setup-node@v5
102102
with:
103103
node-version: '14'
104104
architecture: 'x64' # optional, x64 or x86. If not specified, x64 will be used by default
@@ -118,8 +118,8 @@ jobs:
118118
runs-on: ubuntu-latest
119119
name: Node sample
120120
steps:
121-
- uses: actions/checkout@v4
122-
- uses: actions/setup-node@v4
121+
- uses: actions/checkout@v5
122+
- uses: actions/setup-node@v5
123123
with:
124124
node-version: '20.0.0-v8-canary' # it will install the latest v8 canary release for node 20.0.0
125125
- run: npm ci
@@ -133,8 +133,8 @@ jobs:
133133
runs-on: ubuntu-latest
134134
name: Node sample
135135
steps:
136-
- uses: actions/checkout@v4
137-
- uses: actions/setup-node@v4
136+
- uses: actions/checkout@v5
137+
- uses: actions/setup-node@v5
138138
with:
139139
node-version: '20-v8-canary' # it will install the latest v8 canary release for node 20
140140
- run: npm ci
@@ -149,8 +149,8 @@ jobs:
149149
runs-on: ubuntu-latest
150150
name: Node sample
151151
steps:
152-
- uses: actions/checkout@v4
153-
- uses: actions/setup-node@v4
152+
- uses: actions/checkout@v5
153+
- uses: actions/setup-node@v5
154154
with:
155155
node-version: 'v20.1.1-v8-canary20221103f7e2421e91'
156156
- run: npm ci
@@ -169,8 +169,8 @@ jobs:
169169
runs-on: ubuntu-latest
170170
name: Node sample
171171
steps:
172-
- uses: actions/checkout@v4
173-
- uses: actions/setup-node@v4
172+
- uses: actions/checkout@v5
173+
- uses: actions/setup-node@v5
174174
with:
175175
node-version: '16-nightly' # it will install the latest nightly release for node 16
176176
- run: npm ci
@@ -185,8 +185,8 @@ jobs:
185185
runs-on: ubuntu-latest
186186
name: Node sample
187187
steps:
188-
- uses: actions/checkout@v4
189-
- uses: actions/setup-node@v4
188+
- uses: actions/checkout@v5
189+
- uses: actions/setup-node@v5
190190
with:
191191
node-version: '16.0.0-nightly' # it will install the latest nightly release for node 16.0.0
192192
- run: npm ci
@@ -201,8 +201,8 @@ jobs:
201201
runs-on: ubuntu-latest
202202
name: Node sample
203203
steps:
204-
- uses: actions/checkout@v4
205-
- uses: actions/setup-node@v4
204+
- uses: actions/checkout@v5
205+
- uses: actions/setup-node@v5
206206
with:
207207
node-version: '16.0.0-nightly20210420a0261d231c'
208208
- run: npm ci
@@ -219,8 +219,8 @@ jobs:
219219
runs-on: ubuntu-latest
220220
name: Node sample
221221
steps:
222-
- uses: actions/checkout@v4
223-
- uses: actions/setup-node@v4
222+
- uses: actions/checkout@v5
223+
- uses: actions/setup-node@v5
224224
with:
225225
node-version: '16.0.0-rc.1'
226226
- run: npm ci
@@ -236,8 +236,8 @@ The action follows [actions/cache](https://github.com/actions/cache/blob/main/ex
236236
Yarn caching handles both yarn versions: 1 or 2.
237237
```yaml
238238
steps:
239-
- uses: actions/checkout@v4
240-
- uses: actions/setup-node@v4
239+
- uses: actions/checkout@v5
240+
- uses: actions/setup-node@v5
241241
with:
242242
node-version: '14'
243243
cache: 'yarn'
@@ -255,11 +255,11 @@ steps:
255255
# NOTE: pnpm caching support requires pnpm version >= 6.10.0
256256
257257
steps:
258-
- uses: actions/checkout@v4
258+
- uses: actions/checkout@v5
259259
- uses: pnpm/action-setup@v2
260260
with:
261261
version: 6.32.9
262-
- uses: actions/setup-node@v4
262+
- uses: actions/setup-node@v5
263263
with:
264264
node-version: '14'
265265
cache: 'pnpm'
@@ -274,8 +274,8 @@ steps:
274274
**Using wildcard patterns to cache dependencies**
275275
```yaml
276276
steps:
277-
- uses: actions/checkout@v4
278-
- uses: actions/setup-node@v4
277+
- uses: actions/checkout@v5
278+
- uses: actions/setup-node@v5
279279
with:
280280
node-version: '14'
281281
cache: 'npm'
@@ -287,8 +287,8 @@ steps:
287287
**Using a list of file paths to cache dependencies**
288288
```yaml
289289
steps:
290-
- uses: actions/checkout@v4
291-
- uses: actions/setup-node@v4
290+
- uses: actions/checkout@v5
291+
- uses: actions/setup-node@v5
292292
with:
293293
node-version: '14'
294294
cache: 'npm'
@@ -324,9 +324,9 @@ jobs:
324324
architecture: x86
325325
name: Node ${{ matrix.node_version }} - ${{ matrix.architecture }} on ${{ matrix.os }}
326326
steps:
327-
- uses: actions/checkout@v4
327+
- uses: actions/checkout@v5
328328
- name: Setup node
329-
uses: actions/setup-node@v4
329+
uses: actions/setup-node@v5
330330
with:
331331
node-version: ${{ matrix.node_version }}
332332
architecture: ${{ matrix.architecture }}
@@ -337,16 +337,16 @@ jobs:
337337
## Publish to npmjs and GPR with npm
338338
```yaml
339339
steps:
340-
- uses: actions/checkout@v4
341-
- uses: actions/setup-node@v4
340+
- uses: actions/checkout@v5
341+
- uses: actions/setup-node@v5
342342
with:
343343
node-version: '14.x'
344344
registry-url: 'https://registry.npmjs.org'
345345
- run: npm ci
346346
- run: npm publish
347347
env:
348348
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
349-
- uses: actions/setup-node@v4
349+
- uses: actions/setup-node@v5
350350
with:
351351
registry-url: 'https://npm.pkg.github.com'
352352
- run: npm publish
@@ -357,16 +357,16 @@ steps:
357357
## Publish to npmjs and GPR with yarn
358358
```yaml
359359
steps:
360-
- uses: actions/checkout@v4
361-
- uses: actions/setup-node@v4
360+
- uses: actions/checkout@v5
361+
- uses: actions/setup-node@v5
362362
with:
363363
node-version: '14.x'
364364
registry-url: <registry url>
365365
- run: yarn install --frozen-lockfile
366366
- run: yarn publish
367367
env:
368368
NODE_AUTH_TOKEN: ${{ secrets.YARN_TOKEN }}
369-
- uses: actions/setup-node@v4
369+
- uses: actions/setup-node@v5
370370
with:
371371
registry-url: 'https://npm.pkg.github.com'
372372
- run: yarn publish
@@ -377,8 +377,8 @@ steps:
377377
## Use private packages
378378
```yaml
379379
steps:
380-
- uses: actions/checkout@v4
381-
- uses: actions/setup-node@v4
380+
- uses: actions/checkout@v5
381+
- uses: actions/setup-node@v5
382382
with:
383383
node-version: '14.x'
384384
registry-url: 'https://registry.npmjs.org'
@@ -397,8 +397,8 @@ Below you can find a sample "Setup .yarnrc.yml" step, that is going to allow you
397397

398398
```yaml
399399
steps:
400-
- uses: actions/checkout@v4
401-
- uses: actions/setup-node@v4
400+
- uses: actions/checkout@v5
401+
- uses: actions/setup-node@v5
402402
with:
403403
node-version: '14.x'
404404
- name: Setup .yarnrc.yml
@@ -427,7 +427,7 @@ It is possible to specify a token to authenticate with the mirror using the `mir
427427
The token will be passed as a bearer token in the `Authorization` header.
428428

429429
```yaml
430-
- uses: actions/setup-node@v4
430+
- uses: actions/setup-node@v5
431431
with:
432432
node-version: '14.x'
433433
mirror: 'https://nodejs.org/dist'

0 commit comments

Comments
 (0)