8000 Release version 6.0.0 · github-vrp/github-script@cd8eebf · GitHub
[go: up one dir, main page]
Skip to content

Commit cd8eebf

Browse files
joshmgrossjoshmgross
committed
Release version 6.0.0
1 parent 41e1ab4 commit cd8eebf

File tree

2 files changed

+24
-16
lines changed

2 files changed

+24
-16
lines changed

‎README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,15 @@ defined, so you don't have to import them (see examples below).
3232
See [octokit/rest.js](https://octokit.github.io/rest.js/) for the API client
3333
documentation.
3434

35-
## Breaking changes in V5
35+
## Breaking Changes
36+
37+
### Breaking changes in V6
38+
39+
Version 6 of this action updated the runtime to Node 16 - https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#example-using-nodejs-v16
40+
41+
All scripts are now run with Node 16 instead of Node 12 and are affected by any breaking changes between Node 12 and 16.
42+
43+
### Breaking changes in V5
3644

3745
Version 5 of this action includes the version 5 of `@actions/github` and `@octokit/plugin-rest-endpoint-methods`. As part of this update, the Octokit context available via `github` no longer has REST methods directly. These methods are available via `github.rest.*` - https://github.com/octokit/plugin-rest-endpoint-methods.js/releases/tag/v5.0.0
3846

@@ -50,7 +58,7 @@ The return value of the script will be in the step's outputs under the
5058
"result" key.
5159

5260
```yaml
53-
- uses: actions/github-script@v5
61+
- uses: actions/github-script@v6
5462
id: set-result
5563
with:
5664
script: return "Hello!"
@@ -69,7 +77,7 @@ output of a github-script step. For some workflows, string encoding is preferred
6977
`result-encoding` input:
7078

7179
```yaml
72-
- uses: actions/github-script@v5
80+
- uses: actions/github-script@v6
7381
id: my-script
7482
with:
7583
result-encoding: string
@@ -87,7 +95,7 @@ By default, github-script will use the token provided to your workflow.
8795

8896
```yaml
8997
- name: View context attributes
90-
uses: actions/github-script@v5
98+
uses: actions/github-script@v6
9199
with:
92100
script: console.log(context)
93101
```
@@ -103,7 +111,7 @@ jobs:
103111
comment:
104112
runs-on: ubuntu-latest
105113
steps:
106-
- uses: actions/github-script@v5
114+
- uses: actions/github-script@v6
107115
with:
108116
script: |
109117
github.rest.issues.createComment({
@@ -125,7 +133,7 @@ jobs:
125133
apply-label:
126134
runs-on: ubuntu-latest
127135
steps:
128-
- uses: actions/github-script@v5
136+
- uses: actions/github-script@v6
129137
with:
130138
script: |
131139
github.rest.issues.addLabels({
@@ -145,7 +153,7 @@ jobs:
145153
welcome:
146154
runs-on: ubuntu-latest
147155
steps:
148-
- uses: actions/github-script@v5
156+
- uses: actions/github-script@v6
149157
with:
150158
script: |
151159
// Get a list of all issues created by the PR opener
@@ -188,7 +196,7 @@ jobs:
188196
diff:
189197
runs-on: ubuntu-latest
190198
steps:
191-
- uses: actions/github-script@v5
199+
- uses: actions/github-script@v6
192200
with:
193201
script: |
194202
const diff_url = context.payload.pull_request.diff_url
@@ -212,7 +220,7 @@ jobs:
212220
list-issues:
213221
runs-on: ubuntu-latest
214222
steps:
215-
- uses: actions/github-script@v5
223+
- uses: actions/github-script@v6
216224
with:
217225
script: |
218226
const query = `query($owner:String!, $name:String!, $label:String!) {
@@ -246,7 +254,7 @@ jobs:
246254
runs-on: ubuntu-latest
247255
steps:
248256
- uses: actions/checkout@v2
249-
- uses: actions/github-script@v5
257+
- uses: actions/github-script@v6
250258
with:
251259
script: |
252260
const script = require('./path/to/script.js')
@@ -284,7 +292,7 @@ jobs:
284292
runs-on: ubuntu-latest
285293
steps:
286294
- uses: actions/checkout@v2
287-
- uses: actions/github-script@v5
295+
- uses: actions/github-script@v6
288296
env:
289297
SHA: '${{env.parentSHA}}'
290298
with:
@@ -328,7 +336,7 @@ jobs:
328336
- run: npm ci
329337
# or one-off:
330338
- run: npm install execa
331-
- uses: actions/github-script@v5
339+
- uses: actions/github-script@v6
332340
with:
333341
script: |
334342
const execa = require('execa')
@@ -349,7 +357,7 @@ jobs:
349357
echo-input:
350358
runs-on: ubuntu-latest
351359
steps:
352-
- uses: actions/github-script@v5
360+
- uses: actions/github-script@v6
353361
env:
354362
FIRST_NAME: Mona
355363
LAST_NAME: Octocat
@@ -377,7 +385,7 @@ jobs:
377385
apply-label:
378386
runs-on: ubuntu-latest
379387
steps:
380-
- uses: actions/github-script@v5
388+
- uses: actions/github-script@v6
381389
with:
382390
github-token: ${{ secrets.MY_PAT }}
383391
script: |

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "github-script",
33
"description": "A GitHub action for executing a simple script",
4-
"version": "5.1.0",
4+
"version": "6.0.0",
55
"author": "GitHub",
66
"license": "MIT",
77
"main": "dist/index.js",
@@ -54,4 +54,4 @@
5454
"ts-jest": "^27.0.5",
5555
"typescript": "^4.3.5"
5656
}
57-
}
57+
}

0 commit comments

Comments
 (0)
0