Skip to content

Navigation Menu

Sign in
Appearance settings

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

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 4750f56

Browse filesBrowse files
committed
Add usage information to README
1 parent 8080ea7 commit 4750f56
Copy full SHA for 4750f56

File tree

Expand file treeCollapse file tree

1 file changed

+7
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+7
-0
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+7Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
This action makes it easy to quickly write a script in your workflow that uses the GitHub API and the workflow execution context.
44

5+
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:
6+
7+
- `github` A pre-authenticated [octokit/rest.js](https://github.com/octokit/rest.js) client
8+
- `context` An object containing the [context of the workflow run](https://github.com/actions/toolkit/tree/master/packages/github)
9+
10+
Since the `script` is just a function body, these values will already be defined, so you don't have to (see examples below).
11+
512
See [octokit/rest.js](https://octokit.github.io/rest.js/) for the API client documentation.
613

714
## Examples

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.