1.0.1

Add step results section to readme

.eslintrc.yml

@@ -0,0 +1,13 @@
+root: true
+parser: '@typescript-eslint/parser'
+plugins: ['@typescript-eslint']
+extends:
+  - eslint:recommended
+  - plugin:@typescript-eslint/eslint-recommended
+  - plugin:@typescript-eslint/recommended
+  - prettier/@typescript-eslint
+rules:
+  # '@typescript-eslint/explicit-function-return-type': 0
+  '@typescript-eslint/no-use-before-define':
+    - 2
+    - functions: false

.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+on:
+  push: {branches: master}
+  pull_request: {branches: master}
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with: {node-version: 13.x}
+      - uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
+          restore-keys: ${{runner.os}}-npm-
+      - run: npm ci
+      - run: npm run style:check
+      - run: npm test

.github/workflows/integration.yml

@@ -0,0 +1,17 @@
+on:
+  push: {branches: master}
+
+jobs:
+  integration:
+    runs-on: ubuntu-latest
+    steps:
+      - id: output-set
+        uses: actions/github-script@master
+        with:
+          script: return core.getInput('input-value')
+          result-encoding: string
+          input-value: output
+      - run: |
+          if [[ "${{steps.output-set.outputs.result}}" != "output" ]]; then
+            exit 1
+          fi

.gitignore

@@ -1 +1,2 @@
-node_modules
+/node_modules/
+!/.vscode/

.prettierrc.yml

@@ -0,0 +1,5 @@
+arrowParens: avoid
+bracketSpacing: false
+semi: false
+singleQuote: true
+trailingComma: none

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": true
+  },
+  "files.exclude": {
+    "**/dist": true,
+    "**/node_modules": true
+  }
+}

README.md

@@ -1,16 +1,17 @@
-# github-script
+# github-script ![.github/workflows/integration.yml](https://github.com/actions/github-script/workflows/.github/workflows/integration.yml/badge.svg?event=push) ![.github/workflows/ci.yml](https://github.com/actions/github-script/workflows/.github/workflows/ci.yml/badge.svg?event=push)
 
 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:
+input should be the body of an asynchronous function call. The following
+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)
+- `core` A reference to the [@actions/core](https://github.com/actions/toolkit/tree/master/packages/core) package
 
 Since the `script` is just a function body, these values will already be
 defined, so you don't have to (see examples below).
@@ -19,12 +20,45 @@ 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. 🙂
+future versions. 🙂
 
 ## Development
 
 See [development.md](/docs/development.md).
 
+## Reading step results
+
+The return value of the script will be in the step's outputs under the
+"result" key.
+
+```yaml
+- uses: actions/github-script@v1
+  id: set-result
+  with:
+    script: return "Hello!"
+    result-encoding: string
+- name: Get result
+  run: echo "${{steps.set-result.outputs.result}}"
+```
+
+See ["Result encoding"](#result-encoding) for details on how the encoding of
+these outputs can be changed.
+
+## Result encoding
+
+By default, the JSON-encoded return value of the function is set as the "result" in the
+output of a github-script step. For some workflows, string encoding is preferred. This option can be set using the
+`result-encoding` input:
+
+```yaml
+- uses: actions/github-script@v1
+  id: my-script
+  with:
+    github-token: ${{secrets.GITHUB_TOKEN}}
+    result-encoding: string
+    script: return "I will be string (not JSON) encoded!"
+```
+
 ## Examples
 
 Note that `github-token` is optional in this action, and the input is there
@@ -36,13 +70,14 @@ By default, github-script will use the token provided to your workflow.
 
 ```yaml
 on:
-  issues: {types: opened}
+  issues:
+    types: [opened]
 
 jobs:
   comment:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@0.6.0
+      - uses: actions/github-script@v1
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -58,13 +93,14 @@ jobs:
 
 ```yaml
 on:
-  issues: {types: opened}
+  issues:
+    types: [opened]
 
 jobs:
   apply-label:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@0.6.0
+      - uses: actions/github-script@v1
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -85,7 +121,7 @@ jobs:
   welcome:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@0.6.0
+      - uses: actions/github-script@v1
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -123,14 +159,13 @@ You can use the `github` object to access the Octokit API. For
 instance, `github.request`
 
 ```yaml
-on:
-  pull_request
+on: pull_request
 
 jobs:
   diff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@0.6.0
+      - uses: actions/github-script@v1
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -142,18 +177,42 @@ jobs:
 This will print the full diff object in the screen; `result.data` will
 contain the actual diff text.
 
-### Result encoding
-
-By default, the JSON-encoded return value of the function is set as the "result" in the
-output of a github-script step. For some workflows, string encoding is preferred. This option can be set using the
-`result-encoding` input:
+### Run a separate file
 
+If you don't want to inline your entire script that you want to run, you can
+use a separate JavaScript module in your repository like so:
 
 ```yaml
-- uses: actions/github-script@0.6.0
-  with:
-    github-token: ${{secrets.GITHUB_TOKEN}}
-    result-encoding: string
-    script: |
-      return "I will be string (not JSON) encoded!"
+on: push
+
+jobs:
+  echo-input:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: @actions/checkout@v2
+      - uses: @actions/github-script@v1
+        with:
+          script: |
+            const path = require('path')
+            const scriptPath = path.resolve('./path/to/script.js')
+            console.log(require(scriptPath)({context}))
 ```
+
+And then export a function from your module:
+
+```javascript
+module.exports = ({context}) => {
+  return context.payload.client_payload.value
+}
+```
+
+You can also use async functions in this manner, as long as you `await` it in
+the inline script.
+
+Note that because you can't `require` things like the GitHub context or
+Actions Toolkit libraries, you'll want to pass them as arguments to your
+external function.
+
+Additionally, you'll want to use the [checkout
+action](https://github.com/actions/checkout) to make sure your script file is
+available.

__test__/async-function.test.ts

@@ -0,0 +1,28 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import {callAsyncFunction} from '../src/async-function'
+
+describe('callAsyncFunction', () => {
+  test('calls the function with its arguments', async () => {
+    const result = await callAsyncFunction({foo: 'bar'} as any, 'return foo')
+    expect(result).toEqual('bar')
+  })
+
+  test('throws on ReferenceError', async () => {
+    expect.assertions(1)
+
+    try {
+      await callAsyncFunction({} as any, 'proces')
+    } catch (err) {
+      expect(err).toBeInstanceOf(ReferenceError)
+    }
+  })
+
+  test('can access process', async () => {
+    await callAsyncFunction({} as any, 'process')
+  })
+
+  test('can access console', async () => {
+    await callAsyncFunction({} as any, 'console')
+  })
+})

docs/development.md

@@ -15,7 +15,8 @@ bash> npm run build
 
 It also has a pre-commit hook configured via
 [husky](https://www.npmjs.com/package/husky) that should run the build script
-before each commit.
+before each commit. Additionally, this hook formats code and lints it, as
+well.
 
 ## Releasing
 

package.json

@@ -1,24 +1,55 @@
 {
   "name": "github-script",
-  "version": "0.6.0",
-  "private": true,
-  "main": "dist/index.js",
-  "scripts": {
-    "build": "ncc build src/main.ts"
-  },
+  "description": "A GitHub action for executing a simple script",
+  "version": "1.0.1",
   "author": "GitHub",
   "license": "MIT",
-  "dependencies": {
-    "@actions/core": "^1.1.0",
-    "@actions/github": "^1.1.0"
-  },
-  "devDependencies": {
-    "@zeit/ncc": "^0.20.5",
-    "husky": "^4.0.1"
+  "main": "dist/index.js",
+  "private": true,
+  "scripts": {
+    "build": "ncc build src/main.ts",
+    "format:check": "prettier --check src __test__",
+    "format:write": "prettier --write src __test__",
+    "lint": "eslint src __test__",
+    "style:check": "run-p --continue-on-error --aggregate-output format:check lint",
+    "style:write": "run-p --continue-on-error --aggregate-output format:write lint",
+    "pre-commit": "run-s style:write test build",
+    "test": "jest"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm run build && git add dist/"
+      "pre-commit": "npm run pre-commit && git add dist/"
     }
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "globals": {
+      "ts-jest": {
+        "diagnostics": {
+          "ignoreCodes": [
+            "151001"
+          ]
+        }
+      }
+    }
+  },
+  "dependencies": {
+    "@actions/core": "^1.2.4",
+    "@actions/github": "^2.2.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^25.1.4",
+    "@typescript-eslint/eslint-plugin": "^2.33.0",
+    "@typescript-eslint/parser": "^2.33.0",
+    "@zeit/ncc": "^0.22.0",
+    "eslint": "^7.0.0",
+    "eslint-config-prettier": "^6.11.0",
+    "husky": "^4.2.5",
+    "jest": "^25.1.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.0.5",
+    "ts-jest": "^25.2.1",
+    "typescript": "^3.8.3"
   }
 }

src/async-function.ts

@@ -0,0 +1,20 @@
+import * as core from '@actions/core'
+import {GitHub} from '@actions/github'
+import {Context} from '@actions/github/lib/context'
+
+const AsyncFunction = Object.getPrototypeOf(async () => null).constructor
+
+type AsyncFunctionArguments = {
+  context: Context
+  core: typeof core
+  github: GitHub
+  require: NodeRequire
+}
+
+export function callAsyncFunction<T>(
+  args: AsyncFunctionArguments,
+  source: string
+): Promise<T> {
+  const fn = new AsyncFunction(...Object.keys(args), source)
+  return fn(...Object.values(args))
+}

src/main.ts

@@ -1,23 +1,35 @@
 import * as core from '@actions/core'
 import {context, GitHub} from '@actions/github'
+import {callAsyncFunction} from './async-function'
 
 process.on('unhandledRejection', handleError)
 main().catch(handleError)
 
-async function main() {
-  const AsyncFunction = Object.getPrototypeOf(async () => {}).constructor
+type Options = {
+  log?: Console
+  userAgent?: string
+  previews?: string[]
+}
+
+async function main(): Promise<void> {
   const token = core.getInput('github-token', {required: true})
   const debug = core.getInput('debug')
   const userAgent = core.getInput('user-agent')
   const previews = core.getInput('previews')
-  const opts: {[key: string]: any} = {}
+
+  const opts: Options = {}
   if (debug === 'true') opts.log = console
   if (userAgent != null) opts.userAgent = userAgent
   if (previews != null) opts.previews = previews.split(',')
-  const client = new GitHub(token, opts)
+
+  const github = new GitHub(token, opts)
   const script = core.getInput('script', {required: true})
-  const fn = new AsyncFunction('require', 'github', 'context', script)
-  const result = await fn(require, client, context)
+
+  // Using property/value shorthand on `require` (e.g. `{require}`) causes compilation errors.
+  const result = await callAsyncFunction(
+    {require: require, github, context, core},
+    script
+  )
 
   let encoding = core.getInput('result-encoding')
   encoding = encoding ? encoding : 'json'
@@ -38,12 +50,8 @@ async function main() {
   core.setOutput('result', output)
 }
 
-function handleError(err: any) {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function handleError(err: any): void {
   console.error(err)
-
-  if (err && err.message) {
-    core.setFailed(err.message)
-  } else {
-    core.setFailed(`Unhandled error: ${err}`)
-  }
+  core.setFailed(`Unhandled error: ${err}`)
 }

tsconfig.json

@@ -1,8 +1,9 @@
 {
   "compilerOptions": {
-    "target": "es2018",  
+    "target": "es2018",
     "moduleResolution": "node",
-    "strict": true,            
+    "strict": true,
     "forceConsistentCasingInFileNames": true
-  }
+  },
+  "exclude": ["__test__"]
 }