v0.8.0

.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+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 test

.github/workflows/integration.yml

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

README.md

@@ -1,4 +1,4 @@
-# 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.
@@ -19,7 +19,7 @@ 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
 
@@ -42,7 +42,7 @@ jobs:
   comment:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@0.6.0
+      - uses: actions/github-script@0.8.0
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -64,7 +64,7 @@ jobs:
   apply-label:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@0.6.0
+      - uses: actions/github-script@0.8.0
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -85,7 +85,7 @@ jobs:
   welcome:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@0.6.0
+      - uses: actions/github-script@0.8.0
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -123,14 +123,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@0.8.0
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -148,9 +147,8 @@ By default, the JSON-encoded return value of the function is set as the "result"
 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@0.6.0
+- uses: actions/github-script@0.8.0
   with:
     github-token: ${{secrets.GITHUB_TOKEN}}
     result-encoding: string

__test__/async-function.test.ts

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

package.json

@@ -1,24 +1,43 @@
 {
   "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": "0.8.0",
   "author": "GitHub",
-  "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.1.0",
-    "@actions/github": "^1.1.0"
+    "@actions/core": "^1.2.2",
+    "@actions/github": "^2.1.1"
   },
   "devDependencies": {
-    "@zeit/ncc": "^0.20.5",
-    "husky": "^4.0.1"
+    "@types/jest": "^25.1.3",
+    "@zeit/ncc": "^0.21.1",
+    "husky": "^4.2.3",
+    "jest": "^25.1.0",
+    "ts-jest": "^25.2.1",
+    "typescript": "^3.8.2"
   },
   "husky": {
     "hooks": {
       "pre-commit": "npm run build && git add dist/"
     }
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "globals": {
+      "ts-jest": {
+        "diagnostics": {
+          "ignoreCodes": [
+            "151001"
+          ]
+        }
+      }
+    }
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "private": true,
+  "scripts": {
+    "build": "ncc build src/main.ts",
+    "test": "jest"
   }
 }

src/async-function.ts

@@ -0,0 +1,11 @@
+const AsyncFunction = Object.getPrototypeOf(async () => {}).constructor
+
+type AsyncFunctionArguments = {[key: string]: any}
+
+export function callAsyncFunction(
+  args: AsyncFunctionArguments,
+  source: string
+): Promise<any> {
+  const fn = new AsyncFunction(...Object.keys(args), source)
+  return fn(...Object.values(args))
+}

src/main.ts

@@ -1,11 +1,11 @@
 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
   const token = core.getInput('github-token', {required: true})
   const debug = core.getInput('debug')
   const userAgent = core.getInput('user-agent')
@@ -14,10 +14,14 @@ async function main() {
   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 compilatin errors.
+  const result = await callAsyncFunction(
+    {require: require, github, context},
+    script
+  )
 
   let encoding = core.getInput('result-encoding')
   encoding = encoding ? encoding : 'json'

tsconfig.json

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