mirror of
https://github.com/actions/github-script.git
synced 2025-12-08 16:16:21 +00:00
Rename to github-script
This commit is contained in:
30
README.md
30
README.md
@@ -1,15 +1,25 @@
|
|||||||
# script
|
# github-script
|
||||||
|
|
||||||
This action makes it easy to quickly write a script in your workflow that uses the GitHub API and the workflow run context.
|
This action makes it easy to quickly write a script in your workflow that
|
||||||
|
uses the GitHub API and the workflow run 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:
|
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
|
- `github` A pre-authenticated
|
||||||
- `context` An object containing the [context of the workflow run](https://github.com/actions/toolkit/tree/master/packages/github)
|
[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).
|
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.
|
||||||
|
|
||||||
|
**Note** This action is still a bit of an experiment—the API may change in
|
||||||
|
*future versions. 🙂
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -23,7 +33,7 @@ jobs:
|
|||||||
comment:
|
comment:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/script@1.0.0
|
- uses: actions/github-script@0.1.0
|
||||||
with:
|
with:
|
||||||
github-token: ${{github.token}}
|
github-token: ${{github.token}}
|
||||||
script: |
|
script: |
|
||||||
@@ -40,7 +50,7 @@ jobs:
|
|||||||
apply-label:
|
apply-label:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/script@1.0.0
|
- uses: actions/github-script@0.1.0
|
||||||
with:
|
with:
|
||||||
github-token: ${{github.token}}
|
github-token: ${{github.token}}
|
||||||
script: |
|
script: |
|
||||||
@@ -56,7 +66,7 @@ jobs:
|
|||||||
welcome:
|
welcome:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/script@1.0.0
|
- uses: actions/github-script@0.1.0
|
||||||
with:
|
with:
|
||||||
github-token: ${{github.token}}
|
github-token: ${{github.token}}
|
||||||
script: |
|
script: |
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
name: Script
|
name: GitHub Script
|
||||||
description: An action for running simple scripts with a GitHub client
|
description: An action for running simple scripts with a GitHub client
|
||||||
branding:
|
branding:
|
||||||
color: blue
|
color: blue
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
{
|
{
|
||||||
|
"private": true,
|
||||||
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "^1.0.0",
|
"@actions/core": "^1.0.0",
|
||||||
"@actions/github": "^1.0.0"
|
"@actions/github": "^1.0.0"
|
||||||
|
|||||||
Reference in New Issue
Block a user