Update version to 3.1.1

Add @actions/glob as a script parameter

.gitattributes

@@ -0,0 +1 @@
+.licenses/** -diff linguist-generated=true

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/ci.yml

@@ -1,6 +1,8 @@
+name: CI
+
 on:
-  push: {branches: master}
-  pull_request: {branches: master}
+  push: {branches: main}
+  pull_request: {branches: main}
 
 jobs:
   ci:

.github/workflows/integration.yml

@@ -1,12 +1,14 @@
+name: Integration
+
 on:
-  push: {branches: master}
+  push: {branches: main}
 
 jobs:
   integration:
     runs-on: ubuntu-latest
     steps:
       - id: output-set
-        uses: actions/github-script@master
+        uses: actions/github-script@main
         with:
           script: return core.getInput('input-value')
           result-encoding: string

.github/workflows/licensed.yml

@@ -0,0 +1,27 @@
+name: Licensed
+
+on:
+  push: {branches: main}
+  pull_request: {branches: main}
+  repository_dispatch:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Check licenses
+    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
+      - 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

@@ -0,0 +1,45 @@
+name: Pull Request Test
+
+on:
+  pull_request:
+    branches: main
+    types: [opened, synchronize]
+
+jobs:
+  pull-request-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+        with:
+          script: |
+            // Get the existing comments.
+            const {data: comments} = await github.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.number,
+            })
+
+            // Find any comment already made by the bot.                                                                                                    
+            const botComment = comments.find(comment => comment.user.id === 41898282)                                                                       
+            const commentBody = "Hello from actions/github-script! (${{ github.sha }})"                  
+
+            if (context.payload.pull_request.head.repo.full_name !== 'actions/github-script') {
+              console.log('Not attempting to write comment on PR from fork');
+            } else {
+              if (botComment) {
+                await github.issues.updateComment({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  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
+                })
+              }
+            }

.github/workflows/stale.yml

@@ -0,0 +1,31 @@
+name: Stale Issues & PRs
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+
+jobs:
+  mark_stale:
+    name: Mark issues and PRs as stale
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          exempt-issue-labels: Not Stale
+          exempt-pr-labels: Not Stale
+          stale-issue-message: >
+            This issue is stale because it has been open for 60 days with no
+            activity. Remove the "Stale" label or comment on the issue, or it
+            will be closed in 7 days.
+          stale-pr-message: >
+            This pull request is stale because it has been open for 60 days
+            with no activity. Remove the "Stale" label or comment on the pull
+            request, or it will be closed in 7 days.
+          close-issue-message: >
+            This issue has been marked as stale and closed due to no activity
+            on it.
+          close-pr-message: >
+            This pull request has been marked as stale and closed due to no
+            activity on it.

.licensed.yml

@@ -0,0 +1,14 @@
+sources:
+  npm: true
+
+allowed:
+  - apache-2.0
+  - bsd-2-clause
+  - bsd-3-clause
+  - isc
+  - mit
+  - cc0-1.0
+  - unlicense
+
+reviewed:
+  npm:

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)
+# 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,10 +12,12 @@ 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/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/tree/master/packages/github)
-- `core` A reference to the [@actions/core](https://github.com/actions/toolkit/tree/master/packages/core) package
+  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
 
 Since the `script` is just a function body, these values will already be
 defined, so you don't have to (see examples below).
@@ -32,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@v1
+- uses: actions/github-script@v3
   id: set-result
   with:
     script: return "Hello!"
@@ -51,7 +57,7 @@ output of a github-script step. For some workflows, string encoding is preferred
 `result-encoding` input:
 
 ```yaml
-- uses: actions/github-script@v1
+- uses: actions/github-script@v3
   id: my-script
   with:
     github-token: ${{secrets.GITHUB_TOKEN}}
@@ -66,6 +72,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@v3
+  with:
+    script: console.log(context)
+```
+
 ### Comment on an issue
 
 ```yaml
@@ -77,7 +92,7 @@ jobs:
   comment:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v1
+      - uses: actions/github-script@v3
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -100,7 +115,7 @@ jobs:
   apply-label:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v1
+      - uses: actions/github-script@v3
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -121,7 +136,7 @@ jobs:
   welcome:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v1
+      - uses: actions/github-script@v3
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -165,7 +180,7 @@ jobs:
   diff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v1
+      - uses: actions/github-script@v3
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |
@@ -174,9 +189,44 @@ jobs:
             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 custom GraphQL queries
+
+You can use the `github.graphql` object to run custom GraphQL queries against the GitHub API.
+
+```yaml
+jobs:
+  list-issues:
+    runs-on: ubuntu-latest
+    steps:
+      - 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){
+                issues(first:100, labels: [$label]) {
+                  nodes {
+                    id
+                  }
+                }
+              }
+            }`;
+            const variables = {
+              owner: context.repo.owner,
+              name: context.repo.repo,
+              label: 'wontfix'
+            }
+            const result = await github.graphql(query, variables)
+            console.log(result)
+```
+
 ### Run a separate file
 
 If you don't want to inline your entire script that you want to run, you can
@@ -189,19 +239,20 @@ jobs:
   echo-input:
     runs-on: ubuntu-latest
     steps:
-      - uses: @actions/checkout@v2
-      - uses: @actions/github-script@v1
+      - uses: actions/checkout@v2
+      - uses: actions/github-script@v3
         with:
           script: |
-            const path = require('path')
-            const scriptPath = path.resolve('./path/to/script.js')
-            console.log(require(scriptPath)({context}))
+            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 = ({context}) => {
+module.exports = ({github, context}) => {
   return context.payload.client_payload.value
 }
 ```
@@ -216,3 +267,53 @@ external function.
 Additionally, you'll want to use the [checkout
 action](https://github.com/actions/checkout) to make sure your script file is
 available.
+
+### 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@v3
+        with:
+          script: |
+            const execa = require(`${process.env.GITHUB_WORKSPACE}/node_modules/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@v3
+        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. Bump the [package.json](/package.json#L3) and [package-lock.json](/package-lock.json#L3) version numbers and commit them.
+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 master 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": "1.0.0",
+  "version": "3.1.1",
   "author": "GitHub",
   "license": "MIT",
   "main": "dist/index.js",
@@ -35,21 +35,26 @@
     }
   },
   "dependencies": {
-    "@actions/core": "^1.2.4",
-    "@actions/github": "^2.2.0"
+    "@actions/core": "^1.2.6",
+    "@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": "^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",
+    "@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.7.0",
     "eslint-config-prettier": "^6.11.0",
     "husky": "^4.2.5",
-    "jest": "^25.1.0",
+    "jest": "^26.4.1",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.5",
-    "ts-jest": "^25.2.1",
-    "typescript": "^3.8.3"
+    "ts-jest": "^26.2.0",
+    "typescript": "^4.0.2"
   }
 }

src/async-function.ts

@@ -1,13 +1,17 @@
 import * as core from '@actions/core'
-import {GitHub} from '@actions/github'
 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
 
 type AsyncFunctionArguments = {
   context: Context
   core: typeof core
-  github: GitHub
+  github: InstanceType<typeof GitHub>
+  glob: typeof glob
+  io: typeof io
   require: NodeRequire
 }
 

src/main.ts

@@ -1,5 +1,7 @@
 import * as core from '@actions/core'
-import {context, GitHub} from '@actions/github'
+import {context, getOctokit} from '@actions/github'
+import * as glob from '@actions/glob'
+import * as io from '@actions/io'
 import {callAsyncFunction} from './async-function'
 
 process.on('unhandledRejection', handleError)
@@ -22,12 +24,12 @@ async function main(): Promise<void> {
   if (userAgent != null) opts.userAgent = userAgent
   if (previews != null) opts.previews = previews.split(',')
 
-  const github = new GitHub(token, opts)
+  const github = getOctokit(token, opts)
   const script = core.getInput('script', {required: true})
 
   // Using property/value shorthand on `require` (e.g. `{require}`) causes compilation errors.
   const result = await callAsyncFunction(
-    {require: require, github, context, core},
+    {require: require, github, context, core, glob, io},
     script
   )