Merge pull request #137 from actions/joshgross/update-actions-core

Update @actions/core to 1.2.7

.github/workflows/ci.yml

@@ -1,3 +1,5 @@
+name: CI
+
 on:
   push: {branches: main}
   pull_request: {branches: main}

.github/workflows/integration.yml

@@ -1,12 +1,16 @@
+name: Integration
+
 on:
   push: {branches: main}
+  pull_request: {branches: main}
 
 jobs:
-  integration:
+  test-return:
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v2
       - id: output-set
-        uses: actions/github-script@main
+        uses: ./
         with:
           script: return core.getInput('input-value')
           result-encoding: string
@@ -15,3 +19,39 @@ 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@v1
+        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/pull-request-test.yml

@@ -1,3 +1,5 @@
+name: Pull Request Test
+
 on:
   pull_request:
     branches: main
@@ -22,18 +24,22 @@ jobs:
             const botComment = comments.find(comment => comment.user.id === 41898282)                                                                       
             const commentBody = "Hello from actions/github-script! (${{ github.sha }})"                  
 
-            if (botComment) {
+            if (context.payload.pull_request.head.repo.full_name !== 'actions/github-script') {
-              await github.issues.updateComment({
+              console.log('Not attempting to write comment on PR from fork');
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                comment_id: botComment.id,
-                body: commentBody
-              })
             } else {
-              await github.issues.createComment({
+              if (botComment) {
-                owner: context.repo.owner,
+                await github.issues.updateComment({
-                repo: context.repo.repo,
+                  owner: context.repo.owner,
-                issue_number: context.payload.number,
+                  repo: context.repo.repo,
-                body: commentBody
+                  comment_id: botComment.id,
-              })
+                  body: commentBody
+                })
+              } else {
+                await github.issues.createComment({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  issue_number: context.payload.number,
+                  body: commentBody
+                })
+              }
             }

CODEOWNERS

@@ -0,0 +1 @@
+* @actions/actions-experience

README.md

@@ -1,4 +1,8 @@
-# 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) ![.github/workflows/licensed.yml](https://github.com/actions/github-script/workflows/Licensed/badge.svg?event=push)
+# actions/github-script
+
+[![.github/workflows/integration.yml](https://github.com/actions/github-script/workflows/Integration/badge.svg?event=push&branch=main)](https://github.com/actions/github-script/actions?query=workflow%3AIntegration+branch%3Amain+event%3Apush)
+[![.github/workflows/ci.yml](https://github.com/actions/github-script/workflows/CI/badge.svg?event=push&branch=main)](https://github.com/actions/github-script/actions?query=workflow%3ACI+branch%3Amain+event%3Apush)
+[![.github/workflows/licensed.yml](https://github.com/actions/github-script/workflows/Licensed/badge.svg?event=push&branch=main)](https://github.com/actions/github-script/actions?query=workflow%3ALicensed+branch%3Amain+event%3Apush)
 
 This action makes it easy to quickly write a script in your workflow that
 uses the GitHub API and the workflow run context.
@@ -8,11 +12,18 @@ 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
+  [octokit/rest.js](https://octokit.github.io/rest.js) client with 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
+- `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 (see examples below).
@@ -33,7 +44,7 @@ The return value of the script will be in the step's outputs under the
 "result" key.
 
 ```yaml
-- uses: actions/github-script@v3
+- uses: actions/github-script@v4
   id: set-result
   with:
     script: return "Hello!"
@@ -52,7 +63,7 @@ output of a github-script step. For some workflows, string encoding is preferred
 `result-encoding` input:
 
 ```yaml
-- uses: actions/github-script@v3
+- uses: actions/github-script@v4
   id: my-script
   with:
     github-token: ${{secrets.GITHUB_TOKEN}}
@@ -67,6 +78,15 @@ in case you need to use a non-default token.
 
 By default, github-script will use the token provided to your workflow.
 
+### Print the available attributes of context
+
+```yaml
+- name: View context attributes
+  uses: actions/github-script@v4
+  with:
+    script: console.log(context)
+```
+
 ### Comment on an issue
 
 ```yaml
@@ -78,7 +98,7 @@ jobs:
   comment:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v3
+      - uses: actions/github-script@v4
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -101,7 +121,7 @@ jobs:
   apply-label:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v3
+      - uses: actions/github-script@v4
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -122,7 +142,7 @@ jobs:
   welcome:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v3
+      - uses: actions/github-script@v4
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -166,7 +186,7 @@ jobs:
   diff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v3
+      - uses: actions/github-script@v4
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -182,230 +202,37 @@ using the API.)_
 This will print the full diff object in the screen; `result.data` will
 contain the actual diff text.
 
-### Run a separate file
+### Run custom GraphQL queries
 
-If you don't want to inline your entire script that you want to run, you can
+You can use the `github.graphql` object to run custom GraphQL queries against the GitHub API.
-use a separate JavaScript module in your repository like so:
 
 ```yaml
-on: push
-
 jobs:
-  echo-input:
+  list-issues:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/github-script@v4
-      - uses: actions/github-script@v2
-        with:
-          script: |
-            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
-module.exports = (github, 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.
-
-
-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. 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/blob/main/packages/github/src/context.ts)
-- `core` A reference to the [@actions/core](https://github.com/actions/toolkit/tree/main/packages/core) package
-- `io` A reference to the [@actions/io](https://github.com/actions/toolkit/tree/main/packages/io) package
-
-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.
-
-**Note** This action is still a bit of an experiment—the API may change in
-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@v3
-  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@v3
-  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
-in case you need to use a non-default token.
-
-By default, github-script will use the token provided to your workflow.
-
-### Comment on an issue
-
-```yaml
-on:
-  issues:
-    types: [opened]
-
-jobs:
-  comment:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/github-script@v3
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
-            github.issues.createComment({
+            const query = `query($owner:String!, $name:String!, $label:String!) {
-              issue_number: context.issue.number,
+              repository(owner:$owner, name:$name){
-              owner: context.repo.owner,
+                issues(first:100, labels: [$label]) {
-              repo: context.repo.repo,
+                  nodes {
-              body: '👋 Thanks for reporting!'
+                    id
-            })
+                  }
-```
+                }
-
-### Apply a label to an issue
-
-```yaml
-on:
-  issues:
-    types: [opened]
-
-jobs:
-  apply-label:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/github-script@v3
-        with:
-          github-token: ${{secrets.GITHUB_TOKEN}}
-          script: |
-            github.issues.addLabels({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              labels: ['Triage']
-            })
-```
-
-### Welcome a first-time contributor
-
-```yaml
-on: pull_request
-
-jobs:
-  welcome:
-    runs-on: ubuntu-latest
-    steps:
-      - 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.issues.listForRepo.endpoint.merge({
-              ...context.issue,
-              creator,
-              state: 'all'
-            })
-            const issues = await github.paginate(opts)
-
-            for (const issue of issues) {
-              if (issue.number === context.issue.number) {
-                continue
-              }
-
-              if (issue.pull_request) {
-                return // Creator is already a contributor.
               }
+            }`;
+            const variables = {
+              owner: context.repo.owner,
+              name: context.repo.repo,
+              label: 'wontfix'
             }
-
+            const result = await github.graphql(query, variables)
-            await github.issues.createComment({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: 'Welcome, new contributor!'
-            })
-```
-
-### Download data from a URL
-
-You can use the `github` object to access the Octokit API. For
-instance, `github.request`
-
-```yaml
-on: pull_request
-
-jobs:
-  diff:
-    runs-on: ubuntu-latest
-    steps:
-      - 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)
             console.log(result)
 ```
 
-_(Note that this particular example only works for a public URL, where the
-diff URL is publicly accessible. Getting the diff for a private URL requires
-using the API.)_
-
-This will print the full diff object in the screen; `result.data` will
-contain the actual diff text.
-
 ### Run a separate file
 
 If you don't want to inline your entire script that you want to run, you can
@@ -419,26 +246,21 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/github-script@v2
+      - uses: actions/github-script@v4
         with:
           script: |
-            const script = require(`${process.env.GITHUB_WORKSPACE}/path/to/script.js`)
+            const script = require('./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
-module.exports = (github, context) => {
+module.exports = ({github, 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.
@@ -446,3 +268,91 @@ external function.
 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@v4
+        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.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:
+
+```yaml
+on: push
+
+jobs:
+  echo-input:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - run: npm ci
+      # or one-off:
+      - run: npm install execa
+      - uses: actions/github-script@v4
+        with:
+          script: |
+            const execa = require('execa')
+
+            const { stdout } = await execa('echo', ['hello', 'world'])
+
+            console.log(stdout)
+```
+
+### Use env as input
+
+You can set env vars to use them in your script:
+
+```yaml
+on: push
+
+jobs:
+  echo-input:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@v4
+        env:
+          FIRST_NAME: Mona
+          LAST_NAME: Octocat
+        with:
+          script: |
+            const { FIRST_NAME, LAST_NAME } = process.env
+
+            console.log(`Hello ${FIRST_NAME} ${LAST_NAME}`)
+```

docs/development.md

@@ -22,7 +22,7 @@ well.
 
 Releases are done manually, for now:
 
-1. Ensure that the build is up to date with `npm run build`.
+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.
+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.
+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": "3.0.0",
+  "version": "4.0.2",
   "author": "GitHub",
   "license": "MIT",
   "main": "dist/index.js",
@@ -35,12 +35,13 @@
     }
   },
   "dependencies": {
-    "@actions/core": "^1.2.4",
+    "@actions/core": "^1.2.7",
     "@actions/github": "^4.0.0",
+    "@actions/glob": "^0.1.1",
     "@actions/io": "^1.0.2",
-    "@octokit/core": "^3.1.2",
+    "@octokit/core": "^3.2.1",
-    "@octokit/plugin-paginate-rest": "^2.3.0",
+    "@octokit/plugin-paginate-rest": "^2.6.0",
-    "@octokit/plugin-rest-endpoint-methods": "^4.1.2"
+    "@octokit/plugin-rest-endpoint-methods": "4.2.1"
   },
   "devDependencies": {
     "@types/jest": "^26.0.10",

src/async-function.ts

@@ -1,6 +1,7 @@
 import * as core from '@actions/core'
 import {Context} from '@actions/github/lib/context'
 import {GitHub} from '@actions/github/lib/utils'
+import * as glob from '@actions/glob'
 import * as io from '@actions/io'
 
 const AsyncFunction = Object.getPrototypeOf(async () => null).constructor
@@ -9,8 +10,10 @@ type AsyncFunctionArguments = {
   context: Context
   core: typeof core
   github: InstanceType<typeof GitHub>
+  glob: typeof glob
   io: typeof io
   require: NodeRequire
+  __original_require__: NodeRequire
 }
 
 export function callAsyncFunction<T>(

src/main.ts

@@ -1,7 +1,9 @@
 import * as core from '@actions/core'
 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)
@@ -28,7 +30,15 @@ async function main(): Promise<void> {
 
   // Using property/value shorthand on `require` (e.g. `{require}`) causes compilation errors.
   const result = await callAsyncFunction(
-    {require: require, github, context, core, io},
+    {
+      require: wrapRequire,
+      __original_require__: __non_webpack_require__,
+      github,
+      context,
+      core,
+      glob,
+      io
+    },
     script
   )
 

src/wrap-require.ts

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

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