Commited59741

authored

Merge pull request#653 from actions/sneha-krip/readme-for-v8

README for updating actions/github-script from v7 to v8

2 parents20fe497 +2dc352e commited59741Copy full SHA for ed59741

File tree

1 file changed

+26

-18

lines changed

README.md

1 file changed

+26

-18

lines changed

`‎README.md‎`

Lines changed: 26 additions & 18 deletions

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,14 @@ documentation.`
`53`	`53`
`54`	`54`	`##Breaking Changes`
`55`	`55`
	`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`	`+`
`56`	`64`	`###V7`
`57`	`65`
`58`	`66`	`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
`91`	`99`	To pass inputs, set`env` vars on the action step and reference them in your script with`process.env`:
`92`	`100`
`93`	`101`	```yaml
`94`		`--uses:actions/github-script@v7`
	`102`	`+-uses:actions/github-script@v8`
`95`	`103`	`env:`
`96`	`104`	`TITLE:${{ github.event.pull_request.title }}`
`97`	`105`	`with:`
`@@ -110,7 +118,7 @@ The return value of the script will be in the step's outputs under the`
`110`	`118`	`"result" key.`
`111`	`119`
`112`	`120`	```yaml
`113`		`--uses:actions/github-script@v7`
	`121`	`+-uses:actions/github-script@v8`
`114`	`122`	`id:set-result`
`115`	`123`	`with:`
`116`	`124`	`script:return "Hello!"`
`@@ -129,7 +137,7 @@ output of a github-script step. For some workflows, string encoding is preferred`
`129`	`137`	`result-encoding` input:
`130`	`138`
`131`	`139`	```yaml
`132`		`-- uses: actions/github-script@v7`
	`140`	`+- uses: actions/github-script@v8`
`133`	`141`	`id: my-script`
`134`	`142`	`with:`
`135`	`143`	`result-encoding: string`
`@@ -141,7 +149,7 @@ output of a github-script step. For some workflows, string encoding is preferred`
`141`	`149`	By default, requests made with the `github` instance will not be retried. You can configure this with the `retries` option:
`142`	`150`
`143`	`151`	```yaml
`144`		`-- uses: actions/github-script@v7`
	`152`	`+- uses: actions/github-script@v8`
`145`	`153`	`id: my-script`
`146`	`154`	`with:`
`147`	`155`	`result-encoding: string`
@@ -159,7 +167,7 @@ In this example, request failures from `github.rest.issues.get()` will be retrie
`159`	`167`	You can also configure which status codes should be exempt from retries via the `retry-exempt-status-codes` option:
`160`	`168`
`161`	`169`	```yaml
`162`		`-- uses: actions/github-script@v7`
	`170`	`+- uses: actions/github-script@v8`
`163`	`171`	`id: my-script`
`164`	`172`	`with:`
`165`	`173`	`result-encoding: string`
`@@ -188,7 +196,7 @@ By default, github-script will use the token provided to your workflow.`
`188`	`196`
`189`	`197`	```yaml
`190`	`198`	`- name: View context attributes`
`191`		`- uses: actions/github-script@v7`
	`199`	`+ uses: actions/github-script@v8`
`192`	`200`	`with:`
`193`	`201`	`script: console.log(context)`
`194`	`202`	```
`@@ -204,7 +212,7 @@ jobs:`
`204`	`212`	`comment:`
`205`	`213`	`runs-on: ubuntu-latest`
`206`	`214`	`steps:`
`207`		`- - uses: actions/github-script@v7`
	`215`	`+ - uses: actions/github-script@v8`
`208`	`216`	`with:`
`209`	`217`	`script: \|`
`210`	`218`	`github.rest.issues.createComment({`
`@@ -226,7 +234,7 @@ jobs:`
`226`	`234`	`apply-label:`
`227`	`235`	`runs-on: ubuntu-latest`
`228`	`236`	`steps:`
`229`		`- - uses: actions/github-script@v7`
	`237`	`+ - uses: actions/github-script@v8`
`230`	`238`	`with:`
`231`	`239`	`script: \|`
`232`	`240`	`github.rest.issues.addLabels({`
`@@ -248,7 +256,7 @@ jobs:`
`248`	`256`	`welcome:`
`249`	`257`	`runs-on: ubuntu-latest`
`250`	`258`	`steps:`
`251`		`- - uses: actions/github-script@v7`
	`259`	`+ - uses: actions/github-script@v8`
`252`	`260`	`with:`
`253`	`261`	`script: \|`
`254`	`262`	`// Get a list of all issues created by the PR opener`
`@@ -293,7 +301,7 @@ jobs:`
`293`	`301`	`diff:`
`294`	`302`	`runs-on:ubuntu-latest`
`295`	`303`	`steps:`
`296`		`- -uses:actions/github-script@v7`
	`304`	`+ -uses:actions/github-script@v8`
`297`	`305`	`with:`
`298`	`306`	`script:\|`
`299`	`307`	`const diff_url = context.payload.pull_request.diff_url`
`@@ -317,7 +325,7 @@ jobs:`
`317`	`325`	`list-issues:`
`318`	`326`	`runs-on: ubuntu-latest`
`319`	`327`	`steps:`
`320`		`- - uses: actions/github-script@v7`
	`328`	`+ - uses: actions/github-script@v8`
`321`	`329`	`with:`
`322`	`330`	`script: \|`
`323`	`331`	const query =`query($owner:String!, $name:String!, $label:String!) {
`@@ -351,7 +359,7 @@ jobs:`
`351`	`359`	`runs-on:ubuntu-latest`
`352`	`360`	`steps:`
`353`	`361`	`-uses:actions/checkout@v4`
`354`		`- -uses:actions/github-script@v7`
	`362`	`+ -uses:actions/github-script@v8`
`355`	`363`	`with:`
`356`	`364`	`script:\|`
`357`	`365`	`const script = require('./path/to/script.js')`
`@@ -389,7 +397,7 @@ jobs:`
`389`	`397`	`runs-on:ubuntu-latest`
`390`	`398`	`steps:`
`391`	`399`	`-uses:actions/checkout@v4`
`392`		`- -uses:actions/github-script@v7`
	`400`	`+ -uses:actions/github-script@v8`
`393`	`401`	`env:`
`394`	`402`	`SHA:'${{env.parentSHA}}'`
`395`	`403`	`with:`
`@@ -433,7 +441,7 @@ jobs:`
`433`	`441`	`-run:npm ci`
`434`	`442`	`# or one-off:`
`435`	`443`	`-run:npm install execa`
`436`		`- -uses:actions/github-script@v7`
	`444`	`+ -uses:actions/github-script@v8`
`437`	`445`	`with:`
`438`	`446`	`script:\|`
`439`	`447`	`const execa = require('execa')`
`@@ -463,7 +471,7 @@ jobs:`
`463`	`471`	`runs-on: ubuntu-latest`
`464`	`472`	`steps:`
`465`	`473`	`- uses: actions/checkout@v4`
`466`		`- - uses: actions/github-script@v7`
	`474`	`+ - uses: actions/github-script@v8`
`467`	`475`	`with:`
`468`	`476`	`script: \|`
`469`	`477`	`const { default: printStuff } = await import('${{ github.workspace }}/src/print-stuff.js')`
`@@ -507,7 +515,7 @@ jobs:`
`507`	`515`	`apply-label:`
`508`	`516`	`runs-on: ubuntu-latest`
`509`	`517`	`steps:`
`510`		`- - uses: actions/github-script@v7`
	`518`	`+ - uses: actions/github-script@v8`
`511`	`519`	`with:`
`512`	`520`	`github-token: ${{ secrets.MY_PAT }}`
`513`	`521`	`script: \|`
`@@ -531,7 +539,7 @@ jobs:`
`531`	`539`	`runs-on: ubuntu-latest`
`532`	`540`	`steps:`
`533`	`541`	`- uses: actions/checkout@v4`
`534`		`- - uses: actions/github-script@v7`
	`542`	`+ - uses: actions/github-script@v8`
`535`	`543`	`with:`
`536`	`544`	`script: \|`
`537`	`545`	`const exitCode = await exec.exec('echo', ['hello'])`
`@@ -549,7 +557,7 @@ jobs:`
`549`	`557`	`runs-on: ubuntu-latest`
`550`	`558`	`steps:`
`551`	`559`	`- uses: actions/checkout@v4`
`552`		`- - uses: actions/github-script@v7`
	`560`	`+ - uses: actions/github-script@v8`
`553`	`561`	`with:`
`554`	`562`	`script: \|`
`555`	`563`	`const {`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commited59741

File tree

1 file changed

1 file changed

`‎README.md‎`

0 commit comments