actions/github-script
1
0
Fork 0
mirror of https://github.com/actions/github-script.git synced 2025-12-08 16:16:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add usage information to README

Browse Source
This commit is contained in:
Jonathan Clem
2019-08-29 18:51:10 -04:00
parent 8080ea76f3
commit 4750f56931
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -2,6 +2,13 @@
This action makes it easy to quickly write a script in your workflow that uses the GitHub API and the workflow execution context. This action makes it easy to quickly write a script in your workflow that uses the GitHub API and the workflow execution context.
In order to use this action, a `script` input is provided. The value of that input should be the body of an asynchronous function call. Two arguments will be provided:
- `github` A pre-authenticated [octokit/rest.js](https://github.com/octokit/rest.js) client
- `context` An object containing the [context of the workflow run](https://github.com/actions/toolkit/tree/master/packages/github)
Since the `script` is just a function body, these values will already be defined, so you don't have to (see examples below).
See [octokit/rest.js](https://octokit.github.io/rest.js/) for the API client documentation. See [octokit/rest.js](https://octokit.github.io/rest.js/) for the API client documentation.
## Examples ## Examples