8000 fix: lint · RSS1102/github-script@8f1a91f · GitHub
[go: up one dir, main page]

Skip to content

Commit 8f1a91f

Browse files
committed
fix: lint
1 parent 68f7297 commit 8f1a91f

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,21 @@ documentation.
3535

3636
### V7
3737

38-
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>
38+
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
3939

4040
All scripts are now run with Node 20 instead of Node 16 and are affected by any breaking changes between Node 16 and 20
4141

42-
The `previews` input now only applies to GraphQL API calls as REST API previews are no longer necessary - <https://github.blog/changelog/2021-10-14-rest-api-preview-promotions/>.
42+
The `previews` input now only applies to GraphQL API calls as REST API previews are no longer necessary - https://github.blog/changelog/2021-10-14-rest-api-preview-promotions/.
4343

4444
### V6
4545

46-
Version 6 of this action updated the runtime to Node 16 - <https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions>
46+
Version 6 of this action updated the runtime to Node 16 - https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions
4747

4848
All scripts are now run with Node 16 instead of Node 12 and are affected by any breaking changes between Node 12 and 16.
4949

5050
### V5
5151

52-
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>
52+
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
5353

5454
For example, `github.issues.createComment` in V4 becomes `github.rest.issues.createComment` in V5
5555

@@ -153,8 +153,7 @@ By default, github-script will use the token provided to your workflow.
153153
```yaml
154154
on:
155155
issues:
156-
types: [opened]
157-
156+
158157
# see: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
159158
permissions:
160159
issues: 'write'
@@ -432,14 +431,13 @@ jobs:
432431

433432
### Use scripts with jsDoc support
434433

435-
If you want type support for your scripts, you could use the command below to install the `@actions/github-script` type declaration.
436-
434+
If you want type support for your scripts, you could use the command below to install the
435+
`@actions/github-script` type declaration.
437436
```sh
438437
$ npm i -D @actions/github-script@github:actions/github-script
439438
```
440439

441440
And then add the `jsDoc` declaration to your script like this:
442-
443441
```js
444442
// @ts-check
445443
/** @param {import('@actions/github-script').AsyncFunctionArguments} AsyncFunctionArguments */

0 commit comments

Comments
 (0)
0