|
1 | 1 | # actions/github-script
|
2 | 2 |
|
3 |
| -[](https://github.com/actions/github-script/actions?query=workflow%3AIntegration+branch%3Amain+event%3Apush) |
4 |
| -[](https://github.com/actions/github-script/actions?query=workflow%3ACI+branch%3Amain+event%3Apush) |
5 |
| -[](https://github.com/actions/github-script/actions?query=workflow%3ALicensed+branch%3Amain+event%3Apush) |
| 3 | +[](https://github.com/actions/github-script/actions/workflows/integration.yml) |
| 4 | +[](https://github.com/actions/github-script/actions/workflows/ci.yml) |
| 5 | +[](https://github.com/actions/github-script/actions/workflows/licensed.yml) |
6 | 6 |
|
7 | 7 | This action makes it easy to quickly write a script in your workflow that
|
8 | 8 | uses the GitHub API and the workflow run context.
|
9 | 9 |
|
10 |
| -To use this action, provide an input named `script` that contains the body of an asynchronous function call. |
| 10 | +To use this action, provide an input named `script` that contains the body of an asynchronous JavaScript function call. |
11 | 11 | The following arguments will be provided:
|
12 | 12 |
|
13 | 13 | - `github` A pre-authenticated
|
@@ -429,15 +429,15 @@ jobs:
|
429 | 429 | ### Use scripts with jsDoc support
|
430 | 430 |
|
431 | 431 | If you want type support for your scripts, you could use the command below to install the
|
432 |
| -`github-script` type declaration. |
| 432 | +`@actions/github-script` type declaration. |
433 | 433 | ```sh
|
434 |
| -$ npm i -D @types/github-script@github:actions/github-script |
| 434 | +$ npm i -D @actions/github-script@github:actions/github-script |
435 | 435 | ```
|
436 | 436 |
|
437 | 437 | And then add the `jsDoc` declaration to your script like this:
|
438 | 438 | ```js
|
439 | 439 | // @ts-check
|
440 |
| -/** @param {import('@types/github-script').AsyncFunctionArguments} AsyncFunctionArguments */ |
| 440 | +/** @param {import('@actions/github-script').AsyncFunctionArguments} AsyncFunctionArguments */ |
441 | 441 | export default async ({ core, context }) => {
|
442 | 442 | core.debug("Running something at the moment");
|
443 | 443 | return context.actor;
|
|
0 commit comments