Skip to content

Commit adc0eea

Browse files
sneha-kripsneha-krip
authored
README for updating actions/github-script from v7 to v8
1 parent 20fe497 commit adc0eea

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

‎README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ 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+
5662
### V7
5763

5864
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 +97,7 @@ and potential `SyntaxError`s when the expression is not valid JavaScript code (p
9197
To pass inputs, set `env` vars on the action step and reference them in your script with `process.env`:
9298

9399
```yaml
94-
- uses: actions/github-script@v7
100+
- uses: actions/github-script@v8
95101
env:
96102
TITLE: ${{ github.event.pull_request.title }}
97103
with:
@@ -110,7 +116,7 @@ The return value of the script will be in the step's outputs under the
110116
"result" key.
111117
112118
```yaml
113-
- uses: actions/github-script@v7
119+
- uses: actions/github-script@v8
114120
id: set-result
115121
with:
116122
script: return "Hello!"
@@ -129,7 +135,7 @@ output of a github-script step. For some workflows, string encoding is preferred
129135
`result-encoding` input:
130136

131137
```yaml
132-
- uses: actions/github-script@v7
138+
- uses: actions/github-script@v8
133139
id: my-script
134140
with:
135141
result-encoding: string
@@ -141,7 +147,7 @@ output of a github-script step. For some workflows, string encoding is preferred
141147
By default, requests made with the `github` instance will not be retried. You can configure this with the `retries` option:
142148

143149
```yaml
144-
- uses: actions/github-script@v7
150+
- uses: actions/github-script@v8
145151
id: my-script
146152
with:
147153
result-encoding: string
@@ -159,7 +165,7 @@ In this example, request failures from `github.rest.issues.get()` will be retrie
159165
You can also configure which status codes should be exempt from retries via the `retry-exempt-status-codes` option:
160166

161167
```yaml
162-
- uses: actions/github-script@v7
168+
- uses: actions/github-script@v8
163169
id: my-script
164170
with:
165171
result-encoding: string
@@ -188,7 +194,7 @@ By default, github-script will use the token provided to your workflow.
188194

189195
```yaml
190196
- name: View context attributes
191-
uses: actions/github-script@v7
197+
uses: actions/github-script@v8
192198
with:
193199
script: console.log(context)
194200
```
@@ -204,7 +210,7 @@ jobs:
204210
comment:
205211
runs-on: ubuntu-latest
206212
steps:
207-
- uses: actions/github-script@v7
213+
- uses: actions/github-script@v8
208214
with:
209215
script: |
210216
github.rest.issues.createComment({
@@ -226,7 +232,7 @@ jobs:
226232
apply-label:
227233
runs-on: ubuntu-latest
228234
steps:
229-
- uses: actions/github-script@v7
235+
- uses: actions/github-script@v8
230236
with:
231237
script: |
232238
github.rest.issues.addLabels({
@@ -248,7 +254,7 @@ jobs:
248254
welcome:
249255
runs-on: ubuntu-latest
250256
steps:
251-
- uses: actions/github-script@v7
257+
- uses: actions/github-script@v8
252258
with:
253259
script: |
254260
// Get a list of all issues created by the PR opener
@@ -293,7 +299,7 @@ jobs:
293299
diff:
294300
runs-on: ubuntu-latest
295301
steps:
296-
- uses: actions/github-script@v7
302+
- uses: actions/github-script@v8
297303
with:
298304
script: |
299305
const diff_url = context.payload.pull_request.diff_url
@@ -317,7 +323,7 @@ jobs:
317323
list-issues:
318324
runs-on: ubuntu-latest
319325
steps:
320-
- uses: actions/github-script@v7
326+
- uses: actions/github-script@v8
321327
with:
322328
script: |
323329
const query = `query($owner:String!, $name:String!, $label:String!) {
@@ -351,7 +357,7 @@ jobs:
351357
runs-on: ubuntu-latest
352358
steps:
353359
- uses: actions/checkout@v4
354-
- uses: actions/github-script@v7
360+
- uses: actions/github-script@v8
355361
with:
356362
script: |
357363
const script = require('./path/to/script.js')
@@ -389,7 +395,7 @@ jobs:
389395
runs-on: ubuntu-latest
390396
steps:
391397
- uses: actions/checkout@v4
392-
- uses: actions/github-script@v7
398+
- uses: actions/github-script@v8
393399
env:
394400
SHA: '${{env.parentSHA}}'
395401
with:
@@ -433,7 +439,7 @@ jobs:
433439
- run: npm ci
434440
# or one-off:
435441
- run: npm install execa
436-
- uses: actions/github-script@v7
442+
- uses: actions/github-script@v8
437443
with:
438444
script: |
439445
const execa = require('execa')
@@ -463,7 +469,7 @@ jobs:
463469
runs-on: ubuntu-latest
464470
steps:
465471
- uses: actions/checkout@v4
466-
- uses: actions/github-script@v7
472+
- uses: actions/github-script@v8
467473
with:
468474
script: |
469475
const { default: printStuff } = await import('${{ github.workspace }}/src/print-stuff.js')
@@ -507,7 +513,7 @@ jobs:
507513
apply-label:
508514
runs-on: ubuntu-latest
509515
steps:
510-
- uses: actions/github-script@v7
516+
- uses: actions/github-script@v8
511517
with:
512518
github-token: ${{ secrets.MY_PAT }}
513519
script: |
@@ -531,7 +537,7 @@ jobs:
531537
runs-on: ubuntu-latest
532538
steps:
533539
- uses: actions/checkout@v4
534-
- uses: actions/github-script@v7
540+
- uses: actions/github-script@v8
535541
with:
536542
script: |
537543
const exitCode = await exec.exec('echo', ['hello'])
@@ -549,7 +555,7 @@ jobs:
549555
runs-on: ubuntu-latest
550556
steps:
551557
- uses: actions/checkout@v4
552-
- uses: actions/github-script@v7
558+
- uses: actions/github-script@v8
553559
with:
554560
script: |
555561
const {

0 commit comments

Comments
 (0)