actions/github-script
3
0
Fork 0
mirror of https://github.com/actions/github-script.git synced 2026-02-08 03:57:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: lint

Browse source
This commit is contained in:
阿 Cai 2025-02-05 11:07:51 +08:00
parent 68f729763d
commit 8f1a91f558
1 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -35,21 +35,21 @@ documentation.
### V7 ### V7
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> 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
All scripts are now run with Node 20 instead of Node 16 and are affected by any breaking changes between Node 16 and 20 All scripts are now run with Node 20 instead of Node 16 and are affected by any breaking changes between Node 16 and 20
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/>. 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/.
### V6 ### V6
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> 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
All scripts are now run with Node 16 instead of Node 12 and are affected by any breaking changes between Node 12 and 16. All scripts are now run with Node 16 instead of Node 12 and are affected by any breaking changes between Node 12 and 16.
### V5 ### V5
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> 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
For example, `github.issues.createComment` in V4 becomes `github.rest.issues.createComment` in V5 For example, `github.issues.createComment` in V4 becomes `github.rest.issues.createComment` in V5
@ -153,8 +153,7 @@ By default, github-script will use the token provided to your workflow.
```yaml ```yaml
on: on:
issues: issues:
types: [opened]
# see: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token # see: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token
permissions: permissions:
issues: 'write' issues: 'write'
@ -432,14 +431,13 @@ jobs:
### Use scripts with jsDoc support ### Use scripts with jsDoc support
If you want type support for your scripts, you could use the command below to install the `@actions/github-script` type declaration. If you want type support for your scripts, you could use the command below to install the
`@actions/github-script` type declaration.
```sh ```sh
$ npm i -D @actions/github-script@github:actions/github-script $ npm i -D @actions/github-script@github:actions/github-script
``` ```
And then add the `jsDoc` declaration to your script like this: And then add the `jsDoc` declaration to your script like this:
```js ```js
// @ts-check // @ts-check
/** @param {import('@actions/github-script').AsyncFunctionArguments} AsyncFunctionArguments */ /** @param {import('@actions/github-script').AsyncFunctionArguments} AsyncFunctionArguments */