Merge pull request #352 from actions/rentziass/4.2.0

Prepare release v4.2.0

.github/workflows/codeql-analysis.yml

@@ -1,72 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
-  schedule:
-    - cron: '32 12 * * 3'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
-
-        
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-    # - run: |
-    #   echo "Run, Build Application using script"
-    #   ./location_of_script_within_repo/buildscript.sh
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2

.github/workflows/licensed.yml

@@ -14,11 +14,11 @@ jobs:
     name: Check licenses
     steps:
       - uses: actions/checkout@v2
-        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'
       - run: npm ci
+      - name: Install licensed
+        run: |
+          cd $RUNNER_TEMP
+          curl -Lfs -o licensed.tar.gz https://github.com/github/licensed/releases/download/2.12.2/licensed-2.12.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

@@ -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

@@ -7,8 +7,9 @@
 This action makes it easy to quickly write a script in your workflow that
 uses the GitHub API and the workflow run context.
 
-To use this action, provide an input named `script` that contains the body of an asynchronous function call.
-The following arguments will be provided:
+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://octokit.github.io/rest.js) client with pagination plugins
@@ -26,26 +27,13 @@ The following arguments will be provided:
   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
 
@@ -57,7 +45,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@v4
   id: set-result
   with:
     script: return "Hello!"
@@ -76,54 +64,13 @@ 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@v4
   id: my-script
   with:
     result-encoding: string
     script: return "I will be string (not JSON) encoded!"
 ```
 
-## Retries
-
-By default, requests made with the `github` instance will not be retried. You can configure this with the `retries` option:
-
-```yaml
-- uses: actions/github-script@v6
-  id: my-script
-  with:
-    result-encoding: string
-    retries: 3
-    script: |
-      github.rest.issues.get({
-        issue_number: context.issue.number,
-        owner: context.repo.owner,
-        repo: context.repo.repo,
-      })
-```
-
-In this example, request failures from `github.rest.issues.get()` will be retried up to 3 times.
-
-You can also configure which status codes should be exempt from retries via the `retry-exempt-status-codes` option:
-
-```yaml
-- uses: actions/github-script@v6
-  id: my-script
-  with:
-    result-encoding: string
-    retries: 3
-    retry-exempt-status-codes: 400,401
-    script: |
-      github.rest.issues.get({
-        issue_number: context.issue.number,
-        owner: context.repo.owner,
-        repo: context.repo.repo,
-      })
-```
-
-By default, the following status codes will not be retried: `400, 401, 403, 404, 422` [(source)](https://github.com/octokit/plugin-retry.js/blob/9a2443746c350b3beedec35cf26e197ea318a261/src/index.ts#L14).
-
-These retries are implemented using the [octokit/plugin-retry.js](https://github.com/octokit/plugin-retry.js) plugin. The retries use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) to space out retries. ([source](https://github.com/octokit/plugin-retry.js/blob/9a2443746c350b3beedec35cf26e197ea318a261/src/error-request.ts#L13))
-
 ## Examples
 
 Note that `github-token` is optional in this action, and the input is there
@@ -135,7 +82,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@v4
   with:
     script: console.log(context)
 ```
@@ -151,10 +98,10 @@ jobs:
   comment:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         with:
           script: |
-            github.rest.issues.createComment({
+            github.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
@@ -173,10 +120,10 @@ jobs:
   apply-label:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         with:
           script: |
-            github.rest.issues.addLabels({
+            github.issues.addLabels({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
@@ -186,22 +133,20 @@ jobs:
 
 ### Welcome a first-time contributor
 
-You can format text in comments using the same [Markdown syntax](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) as the GitHub web interface:
-
 ```yaml
-on: pull_request_target
+on: pull_request
 
 jobs:
   welcome:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         with:
           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'
@@ -218,13 +163,11 @@ jobs:
               }
             }
 
-            await github.rest.issues.createComment({
+            await github.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: `**Welcome**, new contributor!
-
-                Please make sure you're read our [contributing guide](CONTRIBUTING.md) and we look forward to reviewing your Pull request shortly ✨`
+              body: 'Welcome, new contributor!'
             })
 ```
 
@@ -240,7 +183,7 @@ jobs:
   diff:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         with:
           script: |
             const diff_url = context.payload.pull_request.diff_url
@@ -264,7 +207,7 @@ jobs:
   list-issues:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         with:
           script: |
             const query = `query($owner:String!, $name:String!, $label:String!) {
@@ -298,7 +241,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         with:
           script: |
             const script = require('./path/to/script.js')
@@ -336,7 +279,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         env:
           SHA: '${{env.parentSHA}}'
         with:
@@ -350,7 +293,7 @@ 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({
+  const commit = await github.repos.getCommit({
     owner: context.repo.owner,
     repo: context.repo.repo,
     ref: `${SHA}`
@@ -380,7 +323,7 @@ jobs:
       - run: npm ci
       # or one-off:
       - run: npm install execa
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         with:
           script: |
             const execa = require('execa')
@@ -390,34 +333,6 @@ jobs:
             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:
@@ -429,7 +344,7 @@ jobs:
   echo-input:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         env:
           FIRST_NAME: Mona
           LAST_NAME: Octocat
@@ -457,11 +372,11 @@ jobs:
   apply-label:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v4
         with:
           github-token: ${{ secrets.MY_PAT }}
           script: |
-            github.rest.issues.addLabels({
+            github.issues.addLabels({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,

__test__/get-retry-options.test.ts

@@ -1,69 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import {getRetryOptions} from '../src/retry-options'
-
-describe('getRequestOptions', () => {
-  test('retries disabled if retries == 0', async () => {
-    const [retryOptions, requestOptions] = getRetryOptions(
-      0,
-      [400, 500, 502],
-      []
-    )
-
-    expect(retryOptions.enabled).toBe(false)
-    expect(retryOptions.doNotRetry).toBeFalsy()
-
-    expect(requestOptions?.retries).toBeFalsy()
-  })
-
-  test('properties set if retries > 0', async () => {
-    const [retryOptions, requestOptions] = getRetryOptions(
-      1,
-      [400, 500, 502],
-      []
-    )
-
-    expect(retryOptions.enabled).toBe(true)
-    expect(retryOptions.doNotRetry).toEqual([400, 500, 502])
-
-    expect(requestOptions?.retries).toEqual(1)
-  })
-
-  test('properties set if retries > 0', async () => {
-    const [retryOptions, requestOptions] = getRetryOptions(
-      1,
-      [400, 500, 502],
-      []
-    )
-
-    expect(retryOptions.enabled).toBe(true)
-    expect(retryOptions.doNotRetry).toEqual([400, 500, 502])
-
-    expect(requestOptions?.retries).toEqual(1)
-  })
-
-  test('retryOptions.doNotRetry not set if exemptStatusCodes isEmpty', async () => {
-    const [retryOptions, requestOptions] = getRetryOptions(1, [], [])
-
-    expect(retryOptions.enabled).toBe(true)
-    expect(retryOptions.doNotRetry).toBeUndefined()
-
-    expect(requestOptions?.retries).toEqual(1)
-  })
-
-  test('requestOptions does not override defaults from @actions/github', async () => {
-    const [retryOptions, requestOptions] = getRetryOptions(1, [], {
-      request: {
-        agent: 'default-user-agent'
-      },
-      foo: 'bar'
-    })
-
-    expect(retryOptions.enabled).toBe(true)
-    expect(retryOptions.doNotRetry).toBeUndefined()
-
-    expect(requestOptions?.retries).toEqual(1)
-    expect(requestOptions?.agent).toEqual('default-user-agent')
-    expect(requestOptions?.foo).toBeUndefined() // this should not be in the `options.request` object, but at the same level as `request`
-  })
-})

action.yml

@@ -21,17 +21,11 @@ inputs:
   previews:
     description: A comma-separated list of API previews to accept
   result-encoding:
-    description: Either "string" or "json" (default "json")—how the result will be encoded
+    description: Either "string" or "json" (default "json")—how the result will be encoded 
     default: json
-  retries:
-    description: The number of times to retry a request
-    default: "0"
-  retry-exempt-status-codes:
-    description: A comma separated list of status codes that will NOT be retried e.g. "400,500". No effect unless `retries` is set
-    default: 400,401,403,404,422 # from https://github.com/octokit/plugin-retry.js/blob/9a2443746c350b3beedec35cf26e197ea318a261/src/index.ts#L14
 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.3.2",
+  "version": "4.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",
@@ -33,26 +37,25 @@
   "dependencies": {
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.0",
-    "@actions/github": "^5.0.0",
-    "@actions/glob": "^0.2.0",
+    "@actions/github": "^4.0.0",
+    "@actions/glob": "^0.1.2",
     "@actions/io": "^1.1.1",
     "@octokit/core": "^3.5.1",
-    "@octokit/plugin-paginate-rest": "^2.17.0",
-    "@octokit/plugin-rest-endpoint-methods": "^6.3.0",
-    "@octokit/plugin-retry": "^3.0.9"
+    "@octokit/plugin-paginate-rest": "^2.16.4",
+    "@octokit/plugin-rest-endpoint-methods": "^4.2.1"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.2",
+    "@types/jest": "^26.0.24",
     "@typescript-eslint/eslint-plugin": "^3.10.1",
     "@typescript-eslint/parser": "^3.10.1",
     "@vercel/ncc": "^0.23.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^6.15.0",
-    "husky": "^7.0.0",
-    "jest": "^27.2.5",
+    "husky": "^4.2.5",
+    "jest": "^26.6.3",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.5",
-    "ts-jest": "^27.0.5",
+    "ts-jest": "^26.5.6",
     "typescript": "^4.3.5"
   }
-}
+}

src/main.ts

@@ -1,13 +1,9 @@
 import * as core from '@actions/core'
 import * as exec from '@actions/exec'
 import {context, getOctokit} from '@actions/github'
-import {defaults as defaultGitHubOptions} from '@actions/github/lib/utils'
 import * as glob from '@actions/glob'
 import * as io from '@actions/io'
-import {retry} from '@octokit/plugin-retry'
-import {RequestRequestOptions} from '@octokit/types'
 import {callAsyncFunction} from './async-function'
-import {getRetryOptions, parseNumberArray, RetryOptions} from './retry-options'
 import {wrapRequire} from './wrap-require'
 
 process.on('unhandledRejection', handleError)
@@ -17,8 +13,6 @@ type Options = {
   log?: Console
   userAgent?: string
   previews?: string[]
-  retry?: RetryOptions
-  request?: RequestRequestOptions
 }
 
 async function main(): Promise<void> {
@@ -26,24 +20,13 @@ async function main(): Promise<void> {
   const debug = core.getInput('debug')
   const userAgent = core.getInput('user-agent')
   const previews = core.getInput('previews')
-  const retries = parseInt(core.getInput('retries'))
-  const exemptStatusCodes = parseNumberArray(
-    core.getInput('retry-exempt-status-codes')
-  )
-  const [retryOpts, requestOpts] = getRetryOptions(
-    retries,
-    exemptStatusCodes,
-    defaultGitHubOptions
-  )
 
   const opts: Options = {}
   if (debug === 'true') opts.log = console
   if (userAgent != null) opts.userAgent = userAgent
   if (previews != null) opts.previews = previews.split(',')
-  if (retryOpts) opts.retry = retryOpts
-  if (requestOpts) opts.request = requestOpts
 
-  const github = getOctokit(token, opts, retry)
+  const github = getOctokit(token, opts)
   const script = core.getInput('script', {required: true})
 
   // Using property/value shorthand on `require` (e.g. `{require}`) causes compilation errors.

src/retry-options.ts

@@ -1,53 +0,0 @@
-import * as core from '@actions/core'
-import {OctokitOptions} from '@octokit/core/dist-types/types'
-import {RequestRequestOptions} from '@octokit/types'
-
-export type RetryOptions = {
-  doNotRetry?: number[]
-  enabled?: boolean
-}
-
-export function getRetryOptions(
-  retries: number,
-  exemptStatusCodes: number[],
-  defaultOptions: OctokitOptions
-): [RetryOptions, RequestRequestOptions | undefined] {
-  if (retries <= 0) {
-    return [{enabled: false}, defaultOptions.request]
-  }
-
-  const retryOptions: RetryOptions = {
-    enabled: true
-  }
-
-  if (exemptStatusCodes.length > 0) {
-    retryOptions.doNotRetry = exemptStatusCodes
-  }
-
-  // The GitHub type has some defaults for `options.request`
-  // see: https://github.com/actions/toolkit/blob/4fbc5c941a57249b19562015edbd72add14be93d/packages/github/src/utils.ts#L15
-  // We pass these in here so they are not overidden.
-  const requestOptions: RequestRequestOptions = {
-    ...defaultOptions.request,
-    retries
-  }
-
-  core.debug(
-    `GitHub client configured with: (retries: ${
-      requestOptions.retries
-    }, retry-exempt-status-code: ${
-      retryOptions?.doNotRetry ?? 'octokit default: [400, 401, 403, 404, 422]'
-    })`
-  )
-
-  return [retryOptions, requestOptions]
-}
-
-export function parseNumberArray(listString: string): number[] {
-  if (!listString) {
-    return []
-  }
-
-  const split = listString.trim().split(',')
-  return split.map(x => parseInt(x))
-}