Merge pull request #348 from actions/rentziass/core-v3

Upgrade @actions/core to 1.10.0 for v3

.github/workflows/check-dist.yml

@@ -1,52 +0,0 @@
-# `dist/index.js` is a special file in Actions.
-# When you reference an action with `uses:` in a workflow,
-# `index.js` is the code that will run.
-# For our project, we generate this file through a build process
-# from other source files.
-# We need to make sure the checked-in `index.js` actually matches what we expect it to be.
-name: Check dist/
-
-on:
-  push:
-    branches:
-      - main
-    paths-ignore:
-      - '**.md'
-  pull_request:
-    paths-ignore:
-      - '**.md'
-  workflow_dispatch:
-
-jobs:
-  check-dist:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Set Node.js 12.x
-        uses: actions/setup-node@v1
-        with:
-          node-version: 12.x
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Rebuild the dist/ directory
-        run: npm run build
-
-      - name: Compare the expected and actual dist/ directories
-        run: |
-          if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then
-            echo "Detected uncommitted changes after build.  See status below:"
-            git diff
-            exit 1
-          fi
-        id: diff
-
-      # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v2
-        if: ${{ failure() && steps.diff.conclusion == 'failure' }}
-        with:
-          name: dist
-          path: dist/

.github/workflows/ci.yml

@@ -1,20 +1,21 @@
 name: CI
 
 on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
+  push: {branches: main}
+  pull_request: {branches: main}
 
 jobs:
   ci:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v1
+        with: {node-version: 13.x}
+      - uses: actions/cache@v1
         with:
-          node-version: 12
-          cache: npm
+          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

@@ -1,18 +1,14 @@
 name: Integration
 
 on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
+  push: {branches: main}
 
 jobs:
-  test-return:
+  integration:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
       - id: output-set
-        uses: ./
+        uses: actions/github-script@main
         with:
           script: return core.getInput('input-value')
           result-encoding: string
@@ -21,39 +17,3 @@ jobs:
           if [[ "${{steps.output-set.outputs.result}}" != "output" ]]; then
             exit 1
           fi
-
-  test-relative-require:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - id: output-set
-        uses: ./
-        with:
-          script: return require('./package.json').name
-          result-encoding: string
-          input-value: output
-      - run: |
-          if [[ "${{steps.output-set.outputs.result}}" != "github-script" ]]; then
-            exit 1
-          fi
-
-  test-npm-require:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v2
-        with:
-          path: ~/.npm
-          key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
-          restore-keys: ${{runner.os}}-npm-
-      - run: npm ci
-      - id: output-set
-        uses: ./
-        with:
-          script: return require('@actions/core/package.json').name
-          result-encoding: string
-          input-value: output
-      - run: |
-          if [[ "${{steps.output-set.outputs.result}}" != "@actions/core" ]]; then
-            exit 1
-          fi

.github/workflows/licensed.yml

@@ -1,12 +1,10 @@
 name: Licensed
 
 on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
+  push: {branches: main}
+  pull_request: {branches: main}
+  repository_dispatch:
+  workflow_dispatch:
 
 jobs:
   test:
@@ -14,11 +12,16 @@ jobs:
     name: Check licenses
     steps:
       - uses: actions/checkout@v2
+      - uses: actions/cache@v1
         with:
-          fetch-depth: 0 # prefer to use a full fetch for licensed workflows
-      # https://github.com/jonabc/setup-licensed/releases/tag/v1.1.1
-      - uses: jonabc/setup-licensed@82c5f4d19e8968efa74a25b132922382c2671fe2
-        with:
-          version: '3.x'
+          path: ~/.npm
+          key: ${{runner.os}}-npm-${{hashFiles('**/package-lock.json')}}
+          restore-keys: ${{runner.os}}-npm-
       - run: npm ci
+      - name: Install licensed
+        run: |-
+          cd $RUNNER_TEMP
+          curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/2.9.2/licensed-2.9.2-linux-x64.tar.gz
+          sudo tar -xzf licensed.tar.gz
+          sudo mv licensed /usr/local/bin/licensed
       - run: licensed status

.github/workflows/pull-request-test.yml

@@ -2,7 +2,7 @@ name: Pull Request Test
 
 on:
   pull_request:
-    branches: [main]
+    branches: main
     types: [opened, synchronize]
 
 jobs:
@@ -14,7 +14,7 @@ jobs:
         with:
           script: |
             // Get the existing comments.
-            const {data: comments} = await github.rest.issues.listComments({
+            const {data: comments} = await github.issues.listComments({
               owner: context.repo.owner,
               repo: context.repo.repo,
               issue_number: context.payload.number,
@@ -28,14 +28,14 @@ jobs:
               console.log('Not attempting to write comment on PR from fork');
             } else {
               if (botComment) {
-                await github.rest.issues.updateComment({
+                await github.issues.updateComment({
                   owner: context.repo.owner,
                   repo: context.repo.repo,
                   comment_id: botComment.id,
                   body: commentBody
                 })
               } else {
-                await github.rest.issues.createComment({
+                await github.issues.createComment({
                   owner: context.repo.owner,
                   repo: context.repo.repo,
                   issue_number: context.payload.number,

.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run pre-commit && git add dist/

README.md

@@ -12,41 +12,21 @@ input should be the body of an asynchronous function call. The following
 arguments will be provided:
 
 - `github` A pre-authenticated
-  [octokit/rest.js](https://octokit.github.io/rest.js) client with pagination plugins
+  [octokit/core.js](https://github.com/octokit/core.js#readme) client with REST endpoints and pagination plugins
 - `context` An object containing the [context of the workflow
   run](https://github.com/actions/toolkit/blob/main/packages/github/src/context.ts)
 - `core` A reference to the [@actions/core](https://github.com/actions/toolkit/tree/main/packages/core) package
 - `glob` A reference to the [@actions/glob](https://github.com/actions/toolkit/tree/main/packages/glob) package
 - `io` A reference to the [@actions/io](https://github.com/actions/toolkit/tree/main/packages/io) package
-- `exec` A reference to the [@actions/exec](https://github.com/actions/toolkit/tree/main/packages/exec) package
-- `require` A proxy wrapper around the normal Node.js `require` to enable
-  requiring relative paths (relative to the current working directory) and
-  requiring npm packages installed in the current working directory. If for
-  some reason you need the non-wrapped `require`, there is an escape hatch
-  available: `__original_require__` is the original value of `require` without
-  our wrapping applied.
 
 Since the `script` is just a function body, these values will already be
-defined, so you don't have to import them (see examples below).
+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.
 
-## Breaking Changes
-
-### Breaking changes in V6
-
-Version 6 of this action updated the runtime to Node 16 - https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#example-using-nodejs-v16
-
-All scripts are now run with Node 16 instead of Node 12 and are affected by any breaking changes between Node 12 and 16.
-
-### Breaking changes in V5
-
-Version 5 of this action includes the version 5 of `@actions/github` and `@octokit/plugin-rest-endpoint-methods`. As part of this update, the Octokit context available via `github` no longer has REST methods directly. These methods are available via `github.rest.*` - https://github.com/octokit/plugin-rest-endpoint-methods.js/releases/tag/v5.0.0
-
-For example, `github.issues.createComment` in V4 becomes `github.rest.issues.createComment` in V5
-
-`github.request`, `github.paginate`, and `github.graphql` are unchanged.
+**Note** This action is still a bit of an experiment—the API may change in
+future versions. 🙂
 
 ## Development
 
@@ -58,7 +38,7 @@ The return value of the script will be in the step's outputs under the
 "result" key.
 
 ```yaml
-- uses: actions/github-script@v6
+- uses: actions/github-script@v3
   id: set-result
   with:
     script: return "Hello!"
@@ -77,9 +57,10 @@ output of a github-script step. For some workflows, string encoding is preferred
 `result-encoding` input:
 
 ```yaml
-- uses: actions/github-script@v6
+- uses: actions/github-script@v3
   id: my-script
   with:
+    github-token: ${{secrets.GITHUB_TOKEN}}
     result-encoding: string
     script: return "I will be string (not JSON) encoded!"
 ```
@@ -95,7 +76,7 @@ By default, github-script will use the token provided to your workflow.
 
 ```yaml
 - name: View context attributes
-  uses: actions/github-script@v6
+  uses: actions/github-script@v3
   with:
     script: console.log(context)
 ```
@@ -111,10 +92,11 @@ jobs:
   comment:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v3
         with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
-            github.rest.issues.createComment({
+            github.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
@@ -133,10 +115,11 @@ jobs:
   apply-label:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v3
         with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
-            github.rest.issues.addLabels({
+            github.issues.addLabels({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
@@ -153,13 +136,14 @@ jobs:
   welcome:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v3
         with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
             // Get a list of all issues created by the PR opener
             // See: https://octokit.github.io/rest.js/#pagination
             const creator = context.payload.sender.login
-            const opts = github.rest.issues.listForRepo.endpoint.merge({
+            const opts = github.issues.listForRepo.endpoint.merge({
               ...context.issue,
               creator,
               state: 'all'
@@ -176,7 +160,7 @@ jobs:
               }
             }
 
-            await github.rest.issues.createComment({
+            await github.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
@@ -196,8 +180,9 @@ jobs:
   diff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v3
         with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
             const diff_url = context.payload.pull_request.diff_url
             const result = await github.request(diff_url)
@@ -220,8 +205,9 @@ jobs:
   list-issues:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v3
         with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
             const query = `query($owner:String!, $name:String!, $label:String!) {
               repository(owner:$owner, name:$name){
@@ -254,13 +240,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v3
         with:
           script: |
-            const script = require('./path/to/script.js')
+            const script = require(`${process.env.GITHUB_WORKSPACE}/path/to/script.js`)
             console.log(script({github, context}))
 ```
 
+_Note that the script path given to `require()` must be an **absolute path** in this case, hence using [`GITHUB_WORKSPACE`](https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables)._
+
 And then export a function from your module:
 
 ```javascript
@@ -269,6 +257,9 @@ module.exports = ({github, context}) => {
 }
 ```
 
+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.
@@ -277,50 +268,9 @@ Additionally, you'll want to use the [checkout
 action](https://github.com/actions/checkout) to make sure your script file is
 available.
 
-### Run a separate file with an async function
-
-You can also use async functions in this manner, as long as you `await` it in
-the inline script.
-
-In your workflow:
-
-```yaml
-on: push
-
-jobs:
-  echo-input:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/github-script@v6
-        env:
-          SHA: '${{env.parentSHA}}'
-        with:
-          script: |
-            const script = require('./path/to/script.js')
-            await script({github, context, core})
-```
-
-And then export an async function from your module:
-
-```javascript
-module.exports = async ({github, context, core}) => {
-  const {SHA} = process.env
-  const commit = await github.rest.repos.getCommit({
-    owner: context.repo.owner,
-    repo: context.repo.repo,
-    ref: `${SHA}`
-  })
-  core.exportVariable('author', commit.data.commit.author.email)
-}
-```
-
 ### Use npm packages
 
-Like importing your own files above, you can also use installed modules.
-Note that this is achieved with a wrapper on top `require`, so if you're
-trying to require a module inside your own file, you might need to import
-it externally or pass the `require` wrapper to your file:
+Like importing your own files above, you can also use installed modules:
 
 ```yaml
 on: push
@@ -336,41 +286,16 @@ jobs:
       - run: npm ci
       # or one-off:
       - run: npm install execa
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v3
         with:
           script: |
-            const execa = require('execa')
+            const execa = require(`${process.env.GITHUB_WORKSPACE}/node_modules/execa`)
 
             const { stdout } = await execa('echo', ['hello', 'world'])
 
             console.log(stdout)
 ```
 
-### Use ESM `import`
-
-To import an ESM file, you'll need to reference your script by an absolute path and ensure you have a `package.json` file with `"type": "module"` specified.
-
-For a script in your repository `src/print-stuff.js`:
-```js
-export default function printStuff() { console.log('stuff') }
-```
-
-```yaml
-on: push
-
-jobs:
-  print-stuff:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/github-script@v6
-        with:
-          script: |
-            const { default: printStuff } = await import('${{ github.workspace }}/src/print-stuff.js')
-
-            await printStuff()
-```
-
 ### Use env as input
 
 You can set env vars to use them in your script:
@@ -382,7 +307,7 @@ jobs:
   echo-input:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v3
         env:
           FIRST_NAME: Mona
           LAST_NAME: Octocat
@@ -392,32 +317,3 @@ jobs:
 
             console.log(`Hello ${FIRST_NAME} ${LAST_NAME}`)
 ```
-
-### Using a separate GitHub token
-
-The `GITHUB_TOKEN` used by default is scoped to the current repository, see [Authentication in a workflow](https://docs.github.com/actions/reference/authentication-in-a-workflow).
-
-If you need access to a different repository or an API that the `GITHUB_TOKEN` doesn't have permissions to, you can provide your own [PAT](https://help.github.com/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) as a secret using the `github-token` input.
-
-[Learn more about creating and using encrypted secrets](https://docs.github.com/actions/reference/encrypted-secrets)
-
-```yaml
-on:
-  issues:
-    types: [opened]
-
-jobs:
-  apply-label:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/github-script@v6
-        with:
-          github-token: ${{ secrets.MY_PAT }}
-          script: |
-            github.rest.issues.addLabels({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              labels: ['Triage']
-            })
-```

action.yml

@@ -27,5 +27,5 @@ outputs:
   result:
     description: The return value of the script, stringified with `JSON.stringify`
 runs:
-  using: node16
+  using: node12
   main: dist/index.js

docs/development.md

@@ -25,4 +25,4 @@ Releases are done manually, for now:
 1. Ensure that the build is up to date with `npm run build`. It's also good to ensure you have the correct dependencies installed by running `npm install` before you build.
 1. Bump the [package.json](/package.json#L3) and [package-lock.json](/package-lock.json#L3) version numbers and commit them. I like to do this with `npm version {major,minor,patch} --no-git-tag-version`. This will bump the version numbers but let you manually commit and tag, yourself.
 1. Update documentation (including updated version numbers).
-1. Tag main with the new version number and create a GitHub release. Make sure you also force-create and force-push tags for minor and patch updates. For example, when creating v5.2.0 (a minor bump), you want to create (or update) `v5`, `v5.2`, and `v5.2.0`.
+1. Tag main with the new version number and create a GitHub release. Make sure you also force-create and force-push tags for minor and patch updates. For example, when creating v5.1.0 (a minor bump), you want to create (or update) `v5`, `v5.1`, and `v5.1.0`.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "github-script",
   "description": "A GitHub action for executing a simple script",
-  "version": "6.0.0",
+  "version": "3.2.0",
   "author": "GitHub",
   "license": "MIT",
   "main": "dist/index.js",
@@ -14,8 +14,12 @@
     "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",
-    "prepare": "husky install"
+    "test": "jest"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run pre-commit && git add dist/"
+    }
   },
   "jest": {
     "preset": "ts-jest",
@@ -31,27 +35,26 @@
     }
   },
   "dependencies": {
-    "@actions/core": "^1.6.0",
-    "@actions/exec": "^1.1.0",
-    "@actions/github": "^5.0.0",
-    "@actions/glob": "^0.2.0",
-    "@actions/io": "^1.1.1",
-    "@octokit/core": "^3.5.1",
-    "@octokit/plugin-paginate-rest": "^2.17.0",
-    "@octokit/plugin-rest-endpoint-methods": "^5.13.0"
+    "@actions/core": "^1.10.0",
+    "@actions/github": "^4.0.0",
+    "@actions/glob": "^0.1.1",
+    "@actions/io": "^1.0.2",
+    "@octokit/core": "^3.2.1",
+    "@octokit/plugin-paginate-rest": "^2.6.0",
+    "@octokit/plugin-rest-endpoint-methods": "4.2.1"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.2",
-    "@typescript-eslint/eslint-plugin": "^3.10.1",
-    "@typescript-eslint/parser": "^3.10.1",
+    "@types/jest": "^26.0.10",
+    "@typescript-eslint/eslint-plugin": "^3.9.1",
+    "@typescript-eslint/parser": "^3.9.1",
     "@vercel/ncc": "^0.23.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^6.15.0",
-    "husky": "^7.0.0",
-    "jest": "^27.2.5",
+    "eslint": "^7.7.0",
+    "eslint-config-prettier": "^6.11.0",
+    "husky": "^4.2.5",
+    "jest": "^26.4.1",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.5",
-    "ts-jest": "^27.0.5",
-    "typescript": "^4.3.5"
+    "ts-jest": "^26.2.0",
+    "typescript": "^4.0.2"
   }
 }

src/async-function.ts

@@ -1,5 +1,4 @@
 import * as core from '@actions/core'
-import * as exec from '@actions/exec'
 import {Context} from '@actions/github/lib/context'
 import {GitHub} from '@actions/github/lib/utils'
 import * as glob from '@actions/glob'
@@ -11,11 +10,9 @@ type AsyncFunctionArguments = {
   context: Context
   core: typeof core
   github: InstanceType<typeof GitHub>
-  exec: typeof exec
   glob: typeof glob
   io: typeof io
   require: NodeRequire
-  __original_require__: NodeRequire
 }
 
 export function callAsyncFunction<T>(

src/main.ts

@@ -1,10 +1,8 @@
 import * as core from '@actions/core'
-import * as exec from '@actions/exec'
 import {context, getOctokit} from '@actions/github'
 import * as glob from '@actions/glob'
 import * as io from '@actions/io'
 import {callAsyncFunction} from './async-function'
-import {wrapRequire} from './wrap-require'
 
 process.on('unhandledRejection', handleError)
 main().catch(handleError)
@@ -31,16 +29,7 @@ async function main(): Promise<void> {
 
   // Using property/value shorthand on `require` (e.g. `{require}`) causes compilation errors.
   const result = await callAsyncFunction(
-    {
-      require: wrapRequire,
-      __original_require__: __non_webpack_require__,
-      github,
-      context,
-      core,
-      exec,
-      glob,
-      io
-    },
+    {require: require, github, context, core, glob, io},
     script
   )
 

src/wrap-require.ts

@@ -1,25 +0,0 @@
-import * as path from 'path'
-
-export const wrapRequire = new Proxy(__non_webpack_require__, {
-  apply: (target, thisArg, [moduleID]) => {
-    if (moduleID.startsWith('.')) {
-      moduleID = path.resolve(moduleID)
-      return target.apply(thisArg, [moduleID])
-    }
-
-    const modulePath = target.resolve.apply(thisArg, [
-      moduleID,
-      {
-        // Webpack does not have an escape hatch for getting the actual
-        // module, other than `eval`.
-        paths: [process.cwd()]
-      }
-    ])
-
-    return target.apply(thisArg, [modulePath])
-  },
-
-  get: (target, prop, receiver) => {
-    Reflect.get(target, prop, receiver)
-  }
-})

types/non-webpack-require.ts

@@ -1 +0,0 @@
-declare const __non_webpack_require__: NodeRequire