From 75fbffad34b20b937992c0a96aef3ec0a5ab6b07 Mon Sep 17 00:00:00 2001 From: Jonathan Clem Date: Thu, 5 Sep 2019 09:06:20 -0400 Subject: [PATCH] Rename to github-script --- README.md | 30 ++++++++++++++++++++---------- action.yml | 2 +- package.json | 2 ++ 3 files changed, 23 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 00e8af7..5c3a0e8 100644 --- a/README.md +++ b/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 -- `context` An object containing the [context of the workflow run](https://github.com/actions/toolkit/tree/master/packages/github) +- `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). +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 @@ -23,7 +33,7 @@ jobs: comment: runs-on: ubuntu-latest steps: - - uses: actions/script@1.0.0 + - uses: actions/github-script@0.1.0 with: github-token: ${{github.token}} script: | @@ -40,7 +50,7 @@ jobs: apply-label: runs-on: ubuntu-latest steps: - - uses: actions/script@1.0.0 + - uses: actions/github-script@0.1.0 with: github-token: ${{github.token}} script: | @@ -56,7 +66,7 @@ jobs: welcome: runs-on: ubuntu-latest steps: - - uses: actions/script@1.0.0 + - uses: actions/github-script@0.1.0 with: github-token: ${{github.token}} script: | diff --git a/action.yml b/action.yml index fc40057..443cf73 100644 --- a/action.yml +++ b/action.yml @@ -1,4 +1,4 @@ -name: Script +name: GitHub Script description: An action for running simple scripts with a GitHub client branding: color: blue diff --git a/package.json b/package.json index 5ea8bdf..f02776b 100644 --- a/package.json +++ b/package.json @@ -1,4 +1,6 @@ { + "private": true, + "license": "MIT", "dependencies": { "@actions/core": "^1.0.0", "@actions/github": "^1.0.0"