Skip to content

Commit ed59741

Browse files
sneha-kripsneha-krip
authored
Merge pull request #653 from actions/sneha-krip/readme-for-v8
README for updating actions/github-script from v7 to v8
2 parents 20fe497 + 2dc352e commit ed59741

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

‎README.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ documentation.
5353

5454
## Breaking Changes
5555

56+
### V8
57+
58+
Version 8 of this action updated the runtime to Node 24 - https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions
59+
60+
All scripts are now run with Node 24 instead of Node 20 and are affected by any breaking changes between Node 20 and 24.
61+
62+
**This requires a minimum Actions Runner version of [v2.327.1](https://github.com/actions/runner/releases/tag/v2.327.1)**
63+
5664
### V7
5765

5866
Version 7 of this action updated the runtime to Node 20 - https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions
@@ -91,7 +99,7 @@ and potential `SyntaxError`s when the expression is not valid JavaScript code (p
9199
To pass inputs, set `env` vars on the action step and reference them in your script with `process.env`:
92100

93101
```yaml
94-
- uses: actions/github-script@v7
102+
- uses: actions/github-script@v8
95103
env:
96104
TITLE: ${{ github.event.pull_request.title }}
97105
with:
@@ -110,7 +118,7 @@ The return value of the script will be in the step's outputs under the
110118
"result" key.
111119
112120
```yaml
113-
- uses: actions/github-script@v7
121+
- uses: actions/github-script@v8
114122
id: set-result
115123
with:
116124
script: return "Hello!"
@@ -129,7 +137,7 @@ output of a github-script step. For some workflows, string encoding is preferred
129137
`result-encoding` input:
130138

131139
```yaml
132-
- uses: actions/github-script@v7
140+
- uses: actions/github-script@v8
133141
id: my-script
134142
with:
135143
result-encoding: string
@@ -141,7 +149,7 @@ output of a github-script step. For some workflows, string encoding is preferred
141149
By default, requests made with the `github` instance will not be retried. You can configure this with the `retries` option:
142150

143151
```yaml
144-
- uses: actions/github-script@v7
152+
- uses: actions/github-script@v8
145153
id: my-script
146154
with:
147155
result-encoding: string
@@ -159,7 +167,7 @@ In this example, request failures from `github.rest.issues.get()` will be retrie
159167
You can also configure which status codes should be exempt from retries via the `retry-exempt-status-codes` option:
160168

161169
```yaml
162-
- uses: actions/github-script@v7
170+
- uses: actions/github-script@v8
163171
id: my-script
164172
with:
165173
result-encoding: string
@@ -188,7 +196,7 @@ By default, github-script will use the token provided to your workflow.
188196

189197
```yaml
190198
- name: View context attributes
191-
uses: actions/github-script@v7
199+
uses: actions/github-script@v8
192200
with:
193201
script: console.log(context)
194202
```
@@ -204,7 +212,7 @@ jobs:
204212
comment:
205213
runs-on: ubuntu-latest
206214
steps:
207-
- uses: actions/github-script@v7
215+
- uses: actions/github-script@v8
208216
with:
209217
script: |
210218
github.rest.issues.createComment({
@@ -226,7 +234,7 @@ jobs:
226234
apply-label:
227235
runs-on: ubuntu-latest
228236
steps:
229-
- uses: actions/github-script@v7
237+
- uses: actions/github-script@v8
230238
with:
231239
script: |
232240
github.rest.issues.addLabels({
@@ -248,7 +256,7 @@ jobs:
248256
welcome:
249257
runs-on: ubuntu-latest
250258
steps:
251-
- uses: actions/github-script@v7
259+
- uses: actions/github-script@v8
252260
with:
253261
script: |
254262
// Get a list of all issues created by the PR opener
@@ -293,7 +301,7 @@ jobs:
293301
diff:
294302
runs-on: ubuntu-latest
295303
steps:
296-
- uses: actions/github-script@v7
304+
- uses: actions/github-script@v8
297305
with:
298306
script: |
299307
const diff_url = context.payload.pull_request.diff_url
@@ -317,7 +325,7 @@ jobs:
317325
list-issues:
318326
runs-on: ubuntu-latest
319327
steps:
320-
- uses: actions/github-script@v7
328+
- uses: actions/github-script@v8
321329
with:
322330
script: |
323331
const query = `query($owner:String!, $name:String!, $label:String!) {
@@ -351,7 +359,7 @@ jobs:
351359
runs-on: ubuntu-latest
352360
steps:
353361
- uses: actions/checkout@v4
354-
- uses: actions/github-script@v7
362+
- uses: actions/github-script@v8
355363
with:
356364
script: |
357365
const script = require('./path/to/script.js')
@@ -389,7 +397,7 @@ jobs:
389397
runs-on: ubuntu-latest
390398
steps:
391399
- uses: actions/checkout@v4
392-
- uses: actions/github-script@v7
400+
- uses: actions/github-script@v8
393401
env:
394402
SHA: '${{env.parentSHA}}'
395403
with:
@@ -433,7 +441,7 @@ jobs:
433441
- run: npm ci
434442
# or one-off:
435443
- run: npm install execa
436-
- uses: actions/github-script@v7
444+
- uses: actions/github-script@v8
437445
with:
438446
script: |
439447
const execa = require('execa')
@@ -463,7 +471,7 @@ jobs:
463471
runs-on: ubuntu-latest
464472
steps:
465473
- uses: actions/checkout@v4
466-
- uses: actions/github-script@v7
474+
- uses: actions/github-script@v8
467475
with:
468476
script: |
469477
const { default: printStuff } = await import('${{ github.workspace }}/src/print-stuff.js')
@@ -507,7 +515,7 @@ jobs:
507515
apply-label:
508516
runs-on: ubuntu-latest
509517
steps:
510-
- uses: actions/github-script@v7
518+
- uses: actions/github-script@v8
511519
with:
512520
github-token: ${{ secrets.MY_PAT }}
513521
script: |
@@ -531,7 +539,7 @@ jobs:
531539
runs-on: ubuntu-latest
532540
steps:
533541
- uses: actions/checkout@v4
534-
- uses: actions/github-script@v7
542+
- uses: actions/github-script@v8
535543
with:
536544
script: |
537545
const exitCode = await exec.exec('echo', ['hello'])
@@ -549,7 +557,7 @@ jobs:
549557
runs-on: ubuntu-latest
550558
steps:
551559
- uses: actions/checkout@v4
552-
- uses: actions/github-script@v7
560+
- uses: actions/github-script@v8
553561
with:
554562
script: |
555563
const {

0 commit comments

Comments
 (0)