Fixing typo in config.test.ts.

README.md

@@ -5,11 +5,11 @@ raise an error if any vulnerabilities or invalid licenses are being introduced.
 
 The action is available for all public repositories, as well as private repositories that have GitHub Advanced Security licensed.
 
-You can see the results on the job logs:
+You can see the results on the job logs
 
 <img width="854" alt="Screen Shot 2022-03-31 at 1 10 51 PM" src="https://user-images.githubusercontent.com/2161/161042286-b22d7dd3-13cb-458d-8744-ce70ed9bf562.png">
 
-or on the job summary:
+or on the job summary
 
 <img src="https://user-images.githubusercontent.com/7847935/182871416-50332bbb-b279-4621-a136-ca72a4314301.png">
 
@@ -33,7 +33,7 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v2
 ```
 
 ### GitHub Enterprise Server
@@ -59,34 +59,163 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v2
 ```
 
-## Configuration options
+## Configuration
 
-Configure this action by either inlining these options in your workflow file, or by using an external configuration file. All configuration options are optional.
+Configure this action by either using an external configuration file,
+or by inlining these options in your workflow file.
 
-| Option                | Usage                                                                                                                                                                             | Possible values                                                                          | Default value |
-|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------|
-| `fail-on-severity`    | Defines the threshold for the level of severity. The action will fail on any pull requests that introduce vulnerabilities of the specified severity level or higher.              | `low`, `moderate`, `high`, `critical`                                                    | `low`         |
-| `allow-licenses`*     | Contains a list of allowed licenses. The action will fail on pull requests that introduce dependencies with licenses that do not match the list.                                  | Any [SPDX-compliant identifier(s)](https://spdx.org/licenses/) | none          |
-| `deny-licenses`*      | Contains a list of prohibited licenses. The action will fail on pull requests that introduce dependencies with licenses that match the list.                                      | Any [SPDX-compliant identifier(s)](https://spdx.org/licenses/) | none          |
-| `fail-on-scopes`†      | Contains a list of strings of the build environments you want to support. The action will fail on pull requests that introduce vulnerabilities in the scopes that match the list. |`runtime`, `development`, `unknown`                                                      | `runtime`     |
-| `allow-ghsas`         | Contains a list of GitHub Advisory Database IDs that can be skipped during detection.                                                                                             | Any GHSAs from the [GitHub Advisory Database](https://github.com/advisories)             | none          |
-| `license-check`       | Enable or disable the license check performed by the action.                                                                                                                                | `true`, `false`                                                                          | `true`       |
-| `vulnerability-check` | Enable or disable the vulnerability check performed by the action.                                                                                                                          | `true`, `false`                                                                          | `true`       |
-| `base-ref`/`head-ref` | Provide custom git references for the git base/head when performing the comparison check. This is only used for event types other than `pull_request` and `pull_request_target`.  | Any valid git ref(s) in your project                                                     | none          |
+## Configuration Options
 
-*not supported for use with GitHub Enterprise Server
+### config-file
 
-†will be supported with GitHub Enterprise Server 3.8 
+A string representing the path to an external configuration file. By
+default external configuration files are not used.
 
+**Possible values**: A string representing the absolute path to the
+configuration file.
+
+**Example**: `config-file: ./.github/dependency-review-config.yml`.
+
+### fail-on-severity
+
+Configure the severity level for alerting. See "[Vulnerability Severity](https://github.com/actions/dependency-review-action#vulnerability-severity)".
+
+**Possible values**: `critical`, `high`, `moderate`, `low`.
+
+**Example**: `fail-on-severity: moderate`.
+
+### fail-on-scopes
+
+A list of strings representing the build environments you want to
+support. The default value is `development, runtime`.
+
+**Possible values**: `development`, `runtime`, `unknown`
+
+**Inline example**: `fail-on-scopes: development, runtime`
+
+**YAML example**:
+
+```yaml
+# this prevents scanning development dependencies
+fail-on-scopes:
+  - runtime
+```
+
+### allow-licenses
+
+Only allow the licenses that comply with the expressions in this list. See "[Licenses](https://github.com/actions/dependency-review-action#licenses)".
+
+**Possible values**: A list of of [SPDX-compliant license identifiers](https://spdx.org/licenses/).
+
+**Inline example**: `allow-licenses: BSD-3-Clause, LGPL-2.1 OR MIT OR BSD-3-Clause`
+
+**YAML example**:
+
+```yaml
+allow-licenses:
+  - BSD-3-Clause
+  - LGPL-2.1
+  - MIT
+  - BSD-3-Clause
+```
+
+### deny-licenses
+
+Add a custom list of licenses you want to block. See
+"[Licenses](https://github.com/actions/dependency-review-action#licenses)".
+
+**Possible values**: Any valid set of [SPDX licenses](https://spdx.org/licenses/).
+
+**Inline example**: `deny-licenses: LGPL-2.0, GPL-2.0+ WITH Bison-exception-2.2`
+
+**YAML example**:
+
+```yaml
+deny-licenses:
+  - LGPL-2.0
+  - GPL-2.0+ WITH Bison-exception-2.2
+```
+
+### allow-ghsas
+
+Add a custom list of GitHub Advisory IDs that can be skipped during detection. 
+
+**Possible values**: Any valid advisory GHSA ids.
+
+**Inline example**: `allow-ghsas: GHSA-abcd-1234-5679, GHSA-efgh-1234-5679`
+
+**YAML example**:
+
+```yaml
+allow-ghsas:
+  - GHSA-abcd-1234-5679
+  - GHSA-efgh-1234-5679
+```
+
+### license-check/vulnerability-check
+
+Disable the license checks or vulnerability checks performed by this Action.
+You can't disable both checks.
+
+**Possible values**: `true` or `false`
+
+**Example**:
+
+```yaml
+license-check: true
+vulnerability-check: false
+```
+
+### base-ref/head-ref
+
+Provide custom git references for the git base/head when performing
+the comparison. If you are using pull requests, or
+`pull_request_target` events you do not need to worry about setting
+this. The values need to be specified for all other event types.
+
+**Possible values**: Any valid git ref(s) in your project.
+
+**Example**:
+
+```yaml
+base-ref: 8bb8a58d6a4028b6c2e314d5caaf273f57644896
+head-ref: 69af5638bf660cf218aad5709a4c100e42a2f37b
+```
+
+### Configuration File
+
+You can use an external configuration file to specify the settings for
+this Action.
+
+Start by specifying that you will be using an external configuration
+file:
+
+```yaml
+- name: Dependency Review
+  uses: actions/dependency-review-action@v2
+  with:
+    config-file: './.github/dependency-review-config.yml'
+```
+
+And then create the file in the path you just specified. **All of these fields are
+optional**:
+
+```yaml
+fail-on-severity: 'critical'
+allow-licenses:
+  - 'GPL-3.0'
+  - 'BSD-3-Clause'
+  - 'MIT'
+```
 
 ### Inline Configuration
 
-You can pass options to the Dependency Review GitHub Action using your workflow file. 
-
-#### Example
+You can pass options to the Dependency Review
+Action using your workflow file. Here's an example of what the full
+file would look like:
 
 ```yaml
 name: 'Dependency Review'
@@ -100,7 +229,7 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
       - name: Dependency Review
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v2
         with:
           fail-on-severity: moderate
 
@@ -108,41 +237,71 @@ jobs:
           deny-licenses: LGPL-2.0, BSD-2-Clause
 ```
 
-### Configuration File
+### Vulnerability Severity
 
-You can use an external configuration file to specify the settings for this action. It can be a local file or a file in an external repository. Refer to the following options for the specification.
+By default the action will fail on any pull request that contains a
+vulnerable dependency, regardless of the severity level. You can override this behavior by
+using the `fail-on-severity` option, which will cause a failure on any pull requests that introduce vulnerabilities of the specified severity level or higher. The possible values are: `critical`, `high`, `moderate`, or `low`. The
+action defaults to `low`.
 
-| Option                | Usage                                                                                                                                                                                    | Possible values                                                                                                                |
-|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
-| `config-file`         | A path to a file in the current repository or an external repository. Use this syntax for external files: `OWNER/REPOSITORY/FILENAME@BRANCH`                                             | **Local file**: `./.github/dependency-review-config.yml` <br> **External repo**: `github/octorepo/dependency-review-config.yml@main` |
-| `external-repo-token` | Specifies a token for fetching the configuration file. It is required if the file resides in a private external repository and for all GitHub Enterprise Server repositories. Create a token in [developer settings](https://github.com/settings/tokens). | Any token with `read` permissions to the repository hosting the config file.                                                   |
-
-#### Example
-
-Start by specifying that you will be using an external configuration file:
+This example will only fail on pull requests with `critical` and `high` vulnerabilities:
 
 ```yaml
 - name: Dependency Review
   uses: actions/dependency-review-action@v2
   with:
-    config-file: './.github/dependency-review-config.yml'
+    fail-on-severity: high
 ```
 
-And then create the file in the path you just specified: 
+### Dependency Scoping
+
+By default the action will only fail on `runtime` dependencies that have vulnerabilities or unacceptable licenses, ignoring `development` dependencies. You can override this behavior with the `fail-on-scopes` option, which will allow you to list the specific dependency scopes you care about. The possible values are: `unknown`, `runtime`, and `development`. Note: Filtering by scope will not be supported on Enterprise Server just yet, as the REST API's introduction of `scope` will be released in an upcoming Enterprise Server version. We will treat all dependencies on Enterprise Server as having a `runtime` scope and thus will not be filtered away.
 
 ```yaml
-fail-on-severity: 'critical'
-allow-licenses:
-  - 'GPL-3.0'
-  - 'BSD-3-Clause'
-  - 'MIT'
+- name: Dependency Review
+  uses: actions/dependency-review-action@v2
+  with:
+    fail-on-scopes: runtime, development
+```
+
+### Licenses
+
+You can set the action to fail on pull requests based on the licenses of the dependencies
+they introduce. With `allow-licenses` you can define the list of licenses
+your repository will accept. Alternatively, you can use `deny-licenses` to only
+forbid a subset of licenses. These options are not supported on Enterprise Server.
+
+You can use the [Licenses
+API](https://docs.github.com/en/rest/licenses) to see the full list of
+supported licenses. Use [SPDX licenses](https://spdx.org/licenses/)
+to filter the licenses. A couple of examples:
+
+```yaml
+# only allow MIT-licensed dependents
+- name: Dependency Review
+  uses: actions/dependency-review-action@v2
+  with:
+    allow-licenses: MIT
+```
+
+```yaml
+# Block Apache 1.1 and 2.0 licensed dependents
+- name: Dependency Review
+  uses: actions/dependency-review-action@v2
+  with:
+    deny-licenses: Apache-1.1+
 ```
 
 ### Considerations
 
 - Checking for licenses is not supported on Enterprise Server.
-- The action will only accept one of the two `license` parameters; an error will be raised if you provide both.
-- We don't have license information for all of your dependents. If we can't detect the license for a dependency **we will inform you, but the action won't fail**.
+- The action will only accept one of the two parameters; an error will
+  be raised if you provide both.
+- By default both parameters are empty (no license checking is
+  performed).
+- We don't have license information for all of your dependents. If we
+  can't detect the license for a dependency **we will inform you, but the
+  action won't fail**.
 
 ## Blocking pull requests
 
@@ -150,11 +309,14 @@ The Dependency Review GitHub Action check will only block a pull request from be
 
 ## Getting help
 
-If you have bug reports, questions or suggestions please [create a new issue](https://github.com/actions/dependency-review-action/issues/new/choose).
+If you have bug reports, questions or suggestions please [create a new
+issue](https://github.com/actions/dependency-review-action/issues/new/choose).
 
 ## Contributing
 
-We are grateful for any contributions made to this project. Please read [CONTRIBUTING.MD](https://github.com/actions/dependency-review-action/blob/main/CONTRIBUTING.md) to get started.
+We are grateful for any contributions made to this project.
+
+Please read [CONTRIBUTING.MD](https://github.com/actions/dependency-review-action/blob/main/CONTRIBUTING.md) to get started.
 
 ## License
 

__tests__/config.test.ts

@@ -1,5 +1,5 @@
 import {expect, test, beforeEach} from '@jest/globals'
-import {readConfig} from '../src/config'
+import {readConfig, readConfigFile} from '../src/config'
 import {getRefs} from '../src/git-refs'
 import * as Utils from '../src/utils'
 
@@ -39,53 +39,43 @@ beforeEach(() => {
 })
 
 test('it defaults to low severity', async () => {
-  const config = await readConfig()
-  expect(config.fail_on_severity).toEqual('low')
+  const options = readConfig()
+  expect(options.fail_on_severity).toEqual('low')
 })
 
 test('it reads custom configs', async () => {
   setInput('fail-on-severity', 'critical')
   setInput('allow-licenses', ' BSD, GPL 2')
 
-  const config = await readConfig()
-  expect(config.fail_on_severity).toEqual('critical')
-  expect(config.allow_licenses).toEqual(['BSD', 'GPL 2'])
+  const options = readConfig()
+  expect(options.fail_on_severity).toEqual('critical')
+  expect(options.allow_licenses).toEqual(['BSD', 'GPL 2'])
 })
 
 test('it defaults to empty allow/deny lists ', async () => {
-  const config = await readConfig()
+  const options = readConfig()
 
-  expect(config.allow_licenses).toEqual(undefined)
-  expect(config.deny_licenses).toEqual(undefined)
+  expect(options.allow_licenses).toEqual(undefined)
+  expect(options.deny_licenses).toEqual(undefined)
 })
 
 test('it raises an error if both an allow and denylist are specified', async () => {
   setInput('allow-licenses', 'MIT')
   setInput('deny-licenses', 'BSD')
 
-  await expect(readConfig()).rejects.toThrow(
-    'You cannot specify both allow-licenses and deny-licenses'
-  )
-})
-test('it raises an error if an empty allow list is specified', async () => {
-  setInput('config-file', './__tests__/fixtures/config-empty-allow-sample.yml')
-
-  await expect(readConfig()).rejects.toThrow(
-    'You should provide at least one license in allow-licenses'
-  )
+  expect(() => readConfig()).toThrow()
 })
 
 test('it raises an error when given an unknown severity', async () => {
   setInput('fail-on-severity', 'zombies')
-
-  await expect(readConfig()).rejects.toThrow(/received 'zombies'/)
+  expect(() => readConfig()).toThrow()
 })
 
 test('it uses the given refs when the event is not a pull request', async () => {
   setInput('base-ref', 'a-custom-base-ref')
   setInput('head-ref', 'a-custom-head-ref')
 
-  const refs = getRefs(await readConfig(), {
+  const refs = getRefs(readConfig(), {
     payload: {},
     eventName: 'workflow_dispatch'
   })
@@ -94,9 +84,9 @@ test('it uses the given refs when the event is not a pull request', async () =>
 })
 
 test('it raises an error when no refs are provided and the event is not a pull request', async () => {
-  const config = await readConfig()
+  const options = readConfig()
   expect(() =>
-    getRefs(config, {
+    getRefs(options, {
       payload: {},
       eventName: 'workflow_dispatch'
     })
@@ -104,142 +94,133 @@ test('it raises an error when no refs are provided and the event is not a pull r
 })
 
 test('it reads an external config file', async () => {
-  setInput('config-file', './__tests__/fixtures/config-allow-sample.yml')
-
-  const config = await readConfig()
-  expect(config.fail_on_severity).toEqual('critical')
-  expect(config.allow_licenses).toEqual(['BSD', 'GPL 2'])
+  let options = readConfigFile('./__tests__/fixtures/config-allow-sample.yml')
+  expect(options.fail_on_severity).toEqual('critical')
+  expect(options.allow_licenses).toEqual(['BSD', 'GPL 2'])
 })
 
 test('raises an error when the the config file was not found', async () => {
-  setInput('config-file', 'fixtures/i-dont-exist')
-  await expect(readConfig()).rejects.toThrow(/Unable to fetch/)
+  expect(() => readConfigFile('fixtures/i-dont-exist')).toThrow()
 })
 
 test('it parses options from both sources', async () => {
   setInput('config-file', './__tests__/fixtures/config-allow-sample.yml')
 
-  let config = await readConfig()
-  expect(config.fail_on_severity).toEqual('critical')
+  let options = readConfig()
+  expect(options.fail_on_severity).toEqual('critical')
 
   setInput('base-ref', 'a-custom-base-ref')
-  config = await readConfig()
-  expect(config.base_ref).toEqual('a-custom-base-ref')
+  options = readConfig()
+  expect(options.base_ref).toEqual('a-custom-base-ref')
 })
 
-test('in case of conflicts, the inline config is the source of truth', async () => {
-  setInput('fail-on-severity', 'low')
+test('in case of conflicts, the external config is the source of truth', async () => {
   setInput('config-file', './__tests__/fixtures/config-allow-sample.yml') // this will set fail-on-severity to 'critical'
 
-  const config = await readConfig()
-  expect(config.fail_on_severity).toEqual('low')
+  let options = readConfig()
+  expect(options.fail_on_severity).toEqual('critical')
+
+  // this should not overwite the previous value
+  setInput('fail-on-severity', 'low')
+  options = readConfig()
+  expect(options.fail_on_severity).toEqual('critical')
 })
 
 test('it uses the default values when loading external files', async () => {
   setInput('config-file', './__tests__/fixtures/no-licenses-config.yml')
-  let config = await readConfig()
-  expect(config.allow_licenses).toEqual(undefined)
-  expect(config.deny_licenses).toEqual(undefined)
+  let options = readConfig()
+  expect(options.allow_licenses).toEqual(undefined)
+  expect(options.deny_licenses).toEqual(undefined)
 
   setInput('config-file', './__tests__/fixtures/license-config-sample.yml')
-  config = await readConfig()
-  expect(config.fail_on_severity).toEqual('low')
+  options = readConfig()
+  expect(options.fail_on_severity).toEqual('low')
 })
 
 test('it accepts an external configuration filename', async () => {
   setInput('config-file', './__tests__/fixtures/no-licenses-config.yml')
-  const config = await readConfig()
-  expect(config.fail_on_severity).toEqual('critical')
+  const options = readConfig()
+  expect(options.fail_on_severity).toEqual('critical')
 })
 
 test('it raises an error when given an unknown severity in an external config file', async () => {
   setInput('config-file', './__tests__/fixtures/invalid-severity-config.yml')
-  await expect(readConfig()).rejects.toThrow()
+  expect(() => readConfig()).toThrow()
 })
 
 test('it defaults to runtime scope', async () => {
-  const config = await readConfig()
-  expect(config.fail_on_scopes).toEqual(['runtime'])
+  const options = readConfig()
+  expect(options.fail_on_scopes).toEqual(['runtime'])
 })
 
 test('it parses custom scopes preference', async () => {
   setInput('fail-on-scopes', 'runtime, development')
-  let config = await readConfig()
-  expect(config.fail_on_scopes).toEqual(['runtime', 'development'])
+  let options = readConfig()
+  expect(options.fail_on_scopes).toEqual(['runtime', 'development'])
 
   clearInputs()
   setInput('fail-on-scopes', 'development')
-  config = await readConfig()
-  expect(config.fail_on_scopes).toEqual(['development'])
+  options = readConfig()
+  expect(options.fail_on_scopes).toEqual(['development'])
 })
 
 test('it raises an error when given invalid scope', async () => {
   setInput('fail-on-scopes', 'runtime, zombies')
-  await expect(readConfig()).rejects.toThrow(/received 'zombies'/)
+  expect(() => readConfig()).toThrow()
 })
 
 test('it defaults to an empty GHSA allowlist', async () => {
-  const config = await readConfig()
-  expect(config.allow_ghsas).toEqual([])
+  const options = readConfig()
+  expect(options.allow_ghsas).toEqual(undefined)
 })
 
 test('it successfully parses GHSA allowlist', async () => {
   setInput('allow-ghsas', 'GHSA-abcd-1234-5679, GHSA-efgh-1234-5679')
-  const config = await readConfig()
-  expect(config.allow_ghsas).toEqual([
+  const options = readConfig()
+  expect(options.allow_ghsas).toEqual([
     'GHSA-abcd-1234-5679',
     'GHSA-efgh-1234-5679'
   ])
 })
 
 test('it defaults to checking licenses', async () => {
-  const config = await readConfig()
-  expect(config.license_check).toBe(true)
+  const options = readConfig()
+  expect(options.license_check).toBe(true)
 })
 
 test('it parses the license-check input', async () => {
   setInput('license-check', 'false')
-  let config = await readConfig()
-  expect(config.license_check).toEqual(false)
+  let options = readConfig()
+  expect(options.license_check).toEqual(false)
 
   clearInputs()
   setInput('license-check', 'true')
-  config = await readConfig()
-  expect(config.license_check).toEqual(true)
+  options = readConfig()
+  expect(options.license_check).toEqual(true)
 })
 
 test('it defaults to checking vulnerabilities', async () => {
-  const config = await readConfig()
-  expect(config.vulnerability_check).toBe(true)
+  const options = readConfig()
+  expect(options.vulnerability_check).toBe(true)
 })
 
 test('it parses the vulnerability-check input', async () => {
   setInput('vulnerability-check', 'false')
-  let config = await readConfig()
-  expect(config.vulnerability_check).toEqual(false)
+  let options = readConfig()
+  expect(options.vulnerability_check).toEqual(false)
 
   clearInputs()
   setInput('vulnerability-check', 'true')
-  config = await readConfig()
-  expect(config.vulnerability_check).toEqual(true)
+  options = readConfig()
+  expect(options.vulnerability_check).toEqual(true)
 })
 
 test('it is not possible to disable both checks', async () => {
   setInput('license-check', 'false')
   setInput('vulnerability-check', 'false')
-  await expect(readConfig()).rejects.toThrow(
-    /Can't disable both license-check and vulnerability-check/
-  )
-})
-
-test('it supports comma-separated lists', async () => {
-  setInput(
-    'config-file',
-    './__tests__/fixtures/inline-license-config-sample.yml'
-  )
-  let config = await readConfig()
-
-  expect(config.allow_licenses).toEqual(['MIT', 'GPL-2.0-only'])
+  expect(() => {
+    readConfig()
+  }).toThrow("Can't disable both license-check and vulnerability-check")
 })
 
 describe('licenses that are not valid SPDX licenses', () => {
@@ -249,15 +230,15 @@ describe('licenses that are not valid SPDX licenses', () => {
 
   test('it raises an error for invalid licenses in allow-licenses', async () => {
     setInput('allow-licenses', ' BSD, GPL 2')
-    await expect(readConfig()).rejects.toThrow(
-      'Invalid license(s) in allow-licenses: BSD,GPL 2'
-    )
+    expect(() => {
+      readConfig()
+    }).toThrow('Invalid license(s) in allow-licenses: BSD, GPL 2')
   })
 
   test('it raises an error for invalid licenses in deny-licenses', async () => {
     setInput('deny-licenses', ' BSD, GPL 2')
-    await expect(readConfig()).rejects.toThrow(
-      'Invalid license(s) in deny-licenses: BSD,GPL 2'
-    )
+    expect(() => {
+      readConfig()
+    }).toThrow('Invalid license(s) in deny-licenses: BSD, GPL 2')
   })
 })

__tests__/fixtures/config-empty-allow-sample.yml

@@ -1,2 +0,0 @@
-fail_on_severity: critical
-allow_licenses: []

__tests__/fixtures/inline-license-config-sample.yml

@@ -1 +0,0 @@
-allow-licenses: MIT, GPL-2.0-only

__tests__/licenses.test.ts

@@ -99,6 +99,17 @@ test('it adds license inside the deny list to forbidden changes', async () => {
   expect(forbidden.length).toEqual(1)
 })
 
+// This is more of a "here's a behavior that might be surprising" than an actual
+// thing we want in the system. Please remove this test after refactoring.
+test('it adds all licenses to forbidden changes when allow is provided an empty array', async () => {
+  const changes: Changes = [npmChange, rubyChange]
+  let {forbidden} = await getInvalidLicenseChanges(changes, {
+    allow: [],
+    deny: ['BSD']
+  })
+  expect(forbidden.length).toBe(2)
+})
+
 test('it does not add license outside the allow list to forbidden changes if it is in removed changes', async () => {
   const changes: Changes = [
     {...npmChange, change_type: 'removed'},

action.yml

@@ -21,7 +21,7 @@ inputs:
     description: The head git ref to be used for this check. Has a default value when the workflow event is `pull_request` or `pull_request_target`. Must be provided otherwise.
     required: false
   config-file:
-    description: A path to the configuration file for the action.
+    description: A filepath to the configuration file for the action.
     required: false
   allow-licenses:
     description: Comma-separated list of allowed licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")
@@ -32,15 +32,6 @@ inputs:
   allow-ghsas:
     description: Comma-separated list of allowed Github Advisory IDs (e.g. "GHSA-abcd-1234-5679, GHSA-efgh-1234-5679")
     required: false
-  external-repo-token:
-    description: A token for fetching external configuration file if it lives in another repository. It is required if the repository is private
-    required: false
-  license-check:
-    description: A boolean to determine if license checks should be performed
-    required: false
-  vulnerability-check:
-    description: A boolean to determine if vulnerability checks should be performed
-    required: false
 runs:
   using: 'node16'
   main: 'dist/index.js'

dist/index.js

@@ -107,6 +107,29 @@ exports.getRefs = getRefs;
 
 "use strict";
 
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -121,7 +144,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.getInvalidLicenseChanges = void 0;
+const core = __importStar(__nccwpck_require__(2186));
 const spdx_satisfies_1 = __importDefault(__nccwpck_require__(4424));
+const octokit_1 = __nccwpck_require__(7467);
 const utils_1 = __nccwpck_require__(918);
 /**
  * Loops through a list of changes, filtering and returning the
@@ -180,11 +205,11 @@ function getInvalidLicenseChanges(changes, licenses) {
 exports.getInvalidLicenseChanges = getInvalidLicenseChanges;
 const fetchGHLicense = (owner, repo) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
+    const octokit = new octokit_1.Octokit({
+        auth: core.getInput('repo-token', { required: true })
+    });
     try {
-        const response = yield (0, utils_1.octokitClient)().rest.licenses.getForRepo({
-            owner,
-            repo
-        });
+        const response = yield octokit.rest.licenses.getForRepo({ owner, repo });
         return (_b = (_a = response.data.license) === null || _a === void 0 ? void 0 : _a.spdx_id) !== null && _b !== void 0 ? _b : null;
     }
     catch (_) {
@@ -325,7 +350,7 @@ const utils_1 = __nccwpck_require__(918);
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const config = yield (0, config_1.readConfig)();
+            const config = (0, config_1.readConfig)();
             const refs = (0, git_refs_1.getRefs)(config, github.context);
             const changes = yield dependencyGraph.compare({
                 owner: github.context.repo.owner,
@@ -532,36 +557,17 @@ exports.ConfigurationOptionsSchema = z
     .object({
     fail_on_severity: exports.SeveritySchema,
     fail_on_scopes: z.array(z.enum(exports.SCOPES)).default(['runtime']),
-    allow_licenses: z.array(z.string()).optional(),
-    deny_licenses: z.array(z.string()).optional(),
+    allow_licenses: z.array(z.string()).default([]),
+    deny_licenses: z.array(z.string()).default([]),
     allow_ghsas: z.array(z.string()).default([]),
     license_check: z.boolean().default(true),
     vulnerability_check: z.boolean().default(true),
-    config_file: z.string().optional(),
-    base_ref: z.string().optional(),
-    head_ref: z.string().optional()
+    config_file: z.string().optional().default('false'),
+    base_ref: z.string(),
+    head_ref: z.string()
 })
-    .superRefine((config, context) => {
-    if (config.allow_licenses && config.deny_licenses) {
-        context.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: 'You cannot specify both allow-licenses and deny-licenses'
-        });
-    }
-    if (config.allow_licenses && config.allow_licenses.length < 1) {
-        context.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: 'You should provide at least one license in allow-licenses'
-        });
-    }
-    if (config.license_check === false &&
-        config.vulnerability_check === false) {
-        context.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: "Can't disable both license-check and vulnerability-check"
-        });
-    }
-});
+    .partial()
+    .refine(obj => !(obj.allow_licenses && obj.deny_licenses), 'Your workflow file has both an allow_licenses list and deny_licenses list, but you can only set one or the other.');
 exports.ChangesSchema = z.array(exports.ChangeSchema);
 
 
@@ -735,36 +741,11 @@ exports.addScannedDependencies = addScannedDependencies;
 
 "use strict";
 
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.octokitClient = exports.isSPDXValid = exports.renderUrl = exports.getManifestsSet = exports.groupDependenciesByManifest = void 0;
-const core = __importStar(__nccwpck_require__(2186));
-const octokit_1 = __nccwpck_require__(7467);
+exports.isSPDXValid = exports.renderUrl = exports.getManifestsSet = exports.groupDependenciesByManifest = void 0;
 const spdx_expression_parse_1 = __importDefault(__nccwpck_require__(1620));
 function groupDependenciesByManifest(changes) {
     var _a;
@@ -802,27 +783,6 @@ function isSPDXValid(license) {
     }
 }
 exports.isSPDXValid = isSPDXValid;
-function isEnterprise() {
-    var _a;
-    const serverUrl = new URL((_a = process.env['GITHUB_SERVER_URL']) !== null && _a !== void 0 ? _a : 'https://github.com');
-    return serverUrl.hostname.toLowerCase() !== 'github.com';
-}
-function octokitClient(token = 'repo-token', required = true) {
-    const opts = {};
-    // auth is only added if token is present. For remote config files in public
-    // repos the token is optional, so it could be undefined.
-    const auth = core.getInput(token, { required });
-    if (auth !== undefined) {
-        opts['auth'] = auth;
-    }
-    //baseUrl is required for GitHub Enterprise Server
-    //https://github.com/octokit/octokit.js/blob/9c8fa89d5b0bc4ddbd6dec638db00a2f6c94c298/README.md?plain=1#L196
-    if (isEnterprise()) {
-        opts['baseUrl'] = new URL('api/v3', process.env['GITHUB_SERVER_URL']);
-    }
-    return new octokit_1.Octokit(opts);
-}
-exports.octokitClient = octokitClient;
 
 
 /***/ }),
@@ -27437,20 +27397,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.readConfig = void 0;
+exports.readConfigFile = exports.readInlineConfig = exports.readConfig = void 0;
 const fs = __importStar(__nccwpck_require__(7147));
 const path_1 = __importDefault(__nccwpck_require__(1017));
 const yaml_1 = __importDefault(__nccwpck_require__(4083));
@@ -27458,43 +27409,6 @@ const core = __importStar(__nccwpck_require__(2186));
 const z = __importStar(__nccwpck_require__(3301));
 const schemas_1 = __nccwpck_require__(1129);
 const utils_1 = __nccwpck_require__(1314);
-function readConfig() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const inlineConfig = readInlineConfig();
-        const configFile = getOptionalInput('config-file');
-        if (configFile !== undefined) {
-            const externalConfig = yield readConfigFile(configFile);
-            return schemas_1.ConfigurationOptionsSchema.parse(Object.assign(Object.assign({}, externalConfig), inlineConfig));
-        }
-        return schemas_1.ConfigurationOptionsSchema.parse(inlineConfig);
-    });
-}
-exports.readConfig = readConfig;
-function readInlineConfig() {
-    const fail_on_severity = getOptionalInput('fail-on-severity');
-    const fail_on_scopes = parseList(getOptionalInput('fail-on-scopes'));
-    const allow_licenses = parseList(getOptionalInput('allow-licenses'));
-    const deny_licenses = parseList(getOptionalInput('deny-licenses'));
-    const allow_ghsas = parseList(getOptionalInput('allow-ghsas'));
-    const license_check = getOptionalBoolean('license-check');
-    const vulnerability_check = getOptionalBoolean('vulnerability-check');
-    const base_ref = getOptionalInput('base-ref');
-    const head_ref = getOptionalInput('head-ref');
-    validateLicenses('allow-licenses', allow_licenses);
-    validateLicenses('deny-licenses', deny_licenses);
-    const keys = {
-        fail_on_severity,
-        fail_on_scopes,
-        allow_licenses,
-        deny_licenses,
-        allow_ghsas,
-        license_check,
-        vulnerability_check,
-        base_ref,
-        head_ref
-    };
-    return Object.fromEntries(Object.entries(keys).filter(([_, value]) => value !== undefined));
-}
 function getOptionalBoolean(name) {
     const value = core.getInput(name);
     return value.length > 0 ? core.getBooleanInput(name) : undefined;
@@ -27517,93 +27431,88 @@ function validateLicenses(key, licenses) {
     }
     const invalid_licenses = licenses.filter(license => !(0, utils_1.isSPDXValid)(license));
     if (invalid_licenses.length > 0) {
-        throw new Error(`Invalid license(s) in ${key}: ${invalid_licenses}`);
+        throw new Error(`Invalid license(s) in ${key}: ${invalid_licenses.join(', ')}`);
     }
 }
-function readConfigFile(filePath) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // match a remote config (e.g. 'owner/repo/filepath@someref')
-        const format = new RegExp('(?<owner>[^/]+)/(?<repo>[^/]+)/(?<path>[^@]+)@(?<ref>.*)');
-        let data;
-        const pieces = format.exec(filePath);
-        try {
-            if ((pieces === null || pieces === void 0 ? void 0 : pieces.groups) && pieces.length === 5) {
-                data = yield getRemoteConfig({
-                    owner: pieces.groups.owner,
-                    repo: pieces.groups.repo,
-                    path: pieces.groups.path,
-                    ref: pieces.groups.ref
-                });
-            }
-            else {
-                data = fs.readFileSync(path_1.default.resolve(filePath), 'utf-8');
-            }
-            return parseConfigFile(data);
-        }
-        catch (error) {
-            throw new Error(`Unable to fetch or parse config file: ${error.message}`);
-        }
-    });
+function readConfig() {
+    const externalConfig = getOptionalInput('config-file');
+    if (externalConfig !== undefined) {
+        const config = readConfigFile(externalConfig);
+        // the reasoning behind reading the inline config when an external
+        // config file is provided is that we still want to allow users to
+        // pass inline options in the presence of an external config file.
+        const inlineConfig = readInlineConfig();
+        // the external config takes precedence
+        return Object.assign({}, inlineConfig, config);
+    }
+    else {
+        return readInlineConfig();
+    }
 }
-function parseConfigFile(configData) {
+exports.readConfig = readConfig;
+function readInlineConfig() {
+    const fail_on_severity = schemas_1.SeveritySchema.parse(getOptionalInput('fail-on-severity'));
+    const fail_on_scopes = z
+        .array(z.enum(schemas_1.SCOPES))
+        .default(['runtime'])
+        .parse(parseList(getOptionalInput('fail-on-scopes')));
+    const allow_licenses = parseList(getOptionalInput('allow-licenses'));
+    const deny_licenses = parseList(getOptionalInput('deny-licenses'));
+    if (allow_licenses !== undefined && deny_licenses !== undefined) {
+        throw new Error("Can't specify both allow_licenses and deny_licenses");
+    }
+    validateLicenses('allow-licenses', allow_licenses);
+    validateLicenses('deny-licenses', deny_licenses);
+    const allow_ghsas = parseList(getOptionalInput('allow-ghsas'));
+    const license_check = z
+        .boolean()
+        .default(true)
+        .parse(getOptionalBoolean('license-check'));
+    const vulnerability_check = z
+        .boolean()
+        .default(true)
+        .parse(getOptionalBoolean('vulnerability-check'));
+    if (license_check === false && vulnerability_check === false) {
+        throw new Error("Can't disable both license-check and vulnerability-check");
+    }
+    const base_ref = getOptionalInput('base-ref');
+    const head_ref = getOptionalInput('head-ref');
+    return {
+        fail_on_severity,
+        fail_on_scopes,
+        allow_licenses,
+        deny_licenses,
+        allow_ghsas,
+        license_check,
+        vulnerability_check,
+        base_ref,
+        head_ref
+    };
+}
+exports.readInlineConfig = readInlineConfig;
+function readConfigFile(filePath) {
+    let data;
     try {
-        const data = yaml_1.default.parse(configData);
-        // These are the options that we support where the user can provide
-        // either a YAML list or a comma-separated string.
-        const listKeys = [
-            'allow-licenses',
-            'deny-licenses',
-            'fail-on-scopes',
-            'allow-ghsas'
-        ];
-        for (const key of Object.keys(data)) {
-            // strings can contain list values (e.g. 'MIT, Apache-2.0'). In this
-            // case we need to parse that into a list (e.g. ['MIT', 'Apache-2.0']).
-            if (listKeys.includes(key)) {
-                const val = data[key];
-                if (typeof val === 'string') {
-                    data[key] = val.split(',').map(x => x.trim());
-                }
-            }
-            // perform SPDX validation
-            if (key === 'allow-licenses' || key === 'deny-licenses') {
-                validateLicenses(key, data[key]);
-            }
-            // get rid of the ugly dashes from the actions conventions
-            if (key.includes('-')) {
-                data[key.replace(/-/g, '_')] = data[key];
-                delete data[key];
-            }
-        }
-        return data;
+        data = fs.readFileSync(path_1.default.resolve(filePath), 'utf-8');
     }
     catch (error) {
         throw error;
     }
-}
-function getRemoteConfig(configOpts) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const { data } = yield (0, utils_1.octokitClient)('external-repo-token', false).rest.repos.getContent({
-                mediaType: {
-                    format: 'raw'
-                },
-                owner: configOpts.owner,
-                repo: configOpts.repo,
-                path: configOpts.path,
-                ref: configOpts.ref
-            });
-            // When using mediaType.format = 'raw', the response.data is a string
-            // but this is not reflected in the return type of getContent, so we're
-            // casting the return value to a string.
-            return z.string().parse(data);
+    data = yaml_1.default.parse(data);
+    for (const key of Object.keys(data)) {
+        if (key === 'allow-licenses' || key === 'deny-licenses') {
+            validateLicenses(key, data[key]);
         }
-        catch (error) {
-            core.debug(error);
-            throw new Error('Error fetching remote config file');
+        // get rid of the ugly dashes from the actions conventions
+        if (key.includes('-')) {
+            data[key.replace(/-/g, '_')] = data[key];
+            delete data[key];
         }
-    });
+    }
+    const values = schemas_1.ConfigurationOptionsSchema.parse(data);
+    return values;
 }
+exports.readConfigFile = readConfigFile;
 
 
 /***/ }),
@@ -27749,36 +27658,17 @@ exports.ConfigurationOptionsSchema = z
     .object({
     fail_on_severity: exports.SeveritySchema,
     fail_on_scopes: z.array(z.enum(exports.SCOPES)).default(['runtime']),
-    allow_licenses: z.array(z.string()).optional(),
-    deny_licenses: z.array(z.string()).optional(),
+    allow_licenses: z.array(z.string()).default([]),
+    deny_licenses: z.array(z.string()).default([]),
     allow_ghsas: z.array(z.string()).default([]),
     license_check: z.boolean().default(true),
     vulnerability_check: z.boolean().default(true),
-    config_file: z.string().optional(),
-    base_ref: z.string().optional(),
-    head_ref: z.string().optional()
+    config_file: z.string().optional().default('false'),
+    base_ref: z.string(),
+    head_ref: z.string()
 })
-    .superRefine((config, context) => {
-    if (config.allow_licenses && config.deny_licenses) {
-        context.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: 'You cannot specify both allow-licenses and deny-licenses'
-        });
-    }
-    if (config.allow_licenses && config.allow_licenses.length < 1) {
-        context.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: 'You should provide at least one license in allow-licenses'
-        });
-    }
-    if (config.license_check === false &&
-        config.vulnerability_check === false) {
-        context.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: "Can't disable both license-check and vulnerability-check"
-        });
-    }
-});
+    .partial()
+    .refine(obj => !(obj.allow_licenses && obj.deny_licenses), 'Your workflow file has both an allow_licenses list and deny_licenses list, but you can only set one or the other.');
 exports.ChangesSchema = z.array(exports.ChangeSchema);
 
 
@@ -27789,36 +27679,11 @@ exports.ChangesSchema = z.array(exports.ChangeSchema);
 
 "use strict";
 
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.octokitClient = exports.isSPDXValid = exports.renderUrl = exports.getManifestsSet = exports.groupDependenciesByManifest = void 0;
-const core = __importStar(__nccwpck_require__(2186));
-const octokit_1 = __nccwpck_require__(7467);
+exports.isSPDXValid = exports.renderUrl = exports.getManifestsSet = exports.groupDependenciesByManifest = void 0;
 const spdx_expression_parse_1 = __importDefault(__nccwpck_require__(1620));
 function groupDependenciesByManifest(changes) {
     var _a;
@@ -27856,27 +27721,6 @@ function isSPDXValid(license) {
     }
 }
 exports.isSPDXValid = isSPDXValid;
-function isEnterprise() {
-    var _a;
-    const serverUrl = new URL((_a = process.env['GITHUB_SERVER_URL']) !== null && _a !== void 0 ? _a : 'https://github.com');
-    return serverUrl.hostname.toLowerCase() !== 'github.com';
-}
-function octokitClient(token = 'repo-token', required = true) {
-    const opts = {};
-    // auth is only added if token is present. For remote config files in public
-    // repos the token is optional, so it could be undefined.
-    const auth = core.getInput(token, { required });
-    if (auth !== undefined) {
-        opts['auth'] = auth;
-    }
-    //baseUrl is required for GitHub Enterprise Server
-    //https://github.com/octokit/octokit.js/blob/9c8fa89d5b0bc4ddbd6dec638db00a2f6c94c298/README.md?plain=1#L196
-    if (isEnterprise()) {
-        opts['baseUrl'] = new URL('api/v3', process.env['GITHUB_SERVER_URL']);
-    }
-    return new octokit_1.Octokit(opts);
-}
-exports.octokitClient = octokitClient;
 
 
 /***/ }),

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "dependency-review-action",
-  "version": "3.0.0",
+  "version": "2.5.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "dependency-review-action",
-      "version": "3.0.0",
+      "version": "2.5.1",
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.10.0",
@@ -24,22 +24,22 @@
       },
       "devDependencies": {
         "@types/jest": "^27.5.2",
-        "@types/node": "^16.18.3",
         "@types/spdx-expression-parse": "^3.0.2",
         "@types/spdx-satisfies": "^0.1.0",
-        "@typescript-eslint/eslint-plugin": "^5.43.0",
-        "@typescript-eslint/parser": "^5.43.0",
+        "@types/node": "^16.18.2",
+        "@typescript-eslint/eslint-plugin": "^5.41.0",
+        "@typescript-eslint/parser": "^5.41.0",
         "@vercel/ncc": "^0.34.0",
-        "esbuild-register": "^3.4.1",
-        "eslint": "^8.27.0",
-        "eslint-plugin-github": "^4.4.1",
-        "eslint-plugin-jest": "^27.1.5",
+        "esbuild-register": "^3.3.3",
+        "eslint": "^8.26.0",
+        "eslint-plugin-github": "^4.4.0",
+        "eslint-plugin-jest": "^27.1.3",
         "jest": "^27.5.1",
         "js-yaml": "^4.1.0",
         "nodemon": "^2.0.20",
         "prettier": "2.7.1",
         "ts-jest": "^27.1.4",
-        "typescript": "^4.9.3"
+        "typescript": "^4.8.4"
       }
     },
     "node_modules/@actions/core": {
@@ -1802,9 +1802,9 @@
       "integrity": "sha512-ssE3Vlrys7sdIzs5LOxCzTVMsU7i9oa/IaW92wF32JFb3CVczqOkru2xspuKczHEbG3nvmPY7IFqVmGGHdNbYw=="
     },
     "node_modules/@types/node": {
-      "version": "16.18.3",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-16.18.3.tgz",
-      "integrity": "sha512-jh6m0QUhIRcZpNv7Z/rpN+ZWXOicUUQbSoWks7Htkbb9IjFQj4kzcX/xFCkjstCj5flMsN8FiSvt+q+Tcs4Llg=="
+      "version": "16.18.2",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-16.18.2.tgz",
+      "integrity": "sha512-KIGQJyya+opDCFvDSZMNNS899ov5jlNdtN7PypgHWeb8e+5vWISdwTRo/ClsNVlmDihzOGqFyNBDamUs7TQQCA=="
     },
     "node_modules/@types/prettier": {
       "version": "2.7.1",
@@ -1852,17 +1852,16 @@
       "dev": true
     },
     "node_modules/@typescript-eslint/eslint-plugin": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.43.0.tgz",
-      "integrity": "sha512-wNPzG+eDR6+hhW4yobEmpR36jrqqQv1vxBq5LJO3fBAktjkvekfr4BRl+3Fn1CM/A+s8/EiGUbOMDoYqWdbtXA==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.41.0.tgz",
+      "integrity": "sha512-DXUS22Y57/LAFSg3x7Vi6RNAuLpTXwxB9S2nIA7msBb/Zt8p7XqMwdpdc1IU7CkOQUPgAqR5fWvxuKCbneKGmA==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/scope-manager": "5.43.0",
-        "@typescript-eslint/type-utils": "5.43.0",
-        "@typescript-eslint/utils": "5.43.0",
+        "@typescript-eslint/scope-manager": "5.41.0",
+        "@typescript-eslint/type-utils": "5.41.0",
+        "@typescript-eslint/utils": "5.41.0",
         "debug": "^4.3.4",
         "ignore": "^5.2.0",
-        "natural-compare-lite": "^1.4.0",
         "regexpp": "^3.2.0",
         "semver": "^7.3.7",
         "tsutils": "^3.21.0"
@@ -1885,14 +1884,14 @@
       }
     },
     "node_modules/@typescript-eslint/parser": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.43.0.tgz",
-      "integrity": "sha512-2iHUK2Lh7PwNUlhFxxLI2haSDNyXvebBO9izhjhMoDC+S3XI9qt2DGFUsiJ89m2k7gGYch2aEpYqV5F/+nwZug==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.41.0.tgz",
+      "integrity": "sha512-HQVfix4+RL5YRWZboMD1pUfFN8MpRH4laziWkkAzyO1fvNOY/uinZcvo3QiFJVS/siNHupV8E5+xSwQZrl6PZA==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/scope-manager": "5.43.0",
-        "@typescript-eslint/types": "5.43.0",
-        "@typescript-eslint/typescript-estree": "5.43.0",
+        "@typescript-eslint/scope-manager": "5.41.0",
+        "@typescript-eslint/types": "5.41.0",
+        "@typescript-eslint/typescript-estree": "5.41.0",
         "debug": "^4.3.4"
       },
       "engines": {
@@ -1912,13 +1911,13 @@
       }
     },
     "node_modules/@typescript-eslint/scope-manager": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.43.0.tgz",
-      "integrity": "sha512-XNWnGaqAtTJsUiZaoiGIrdJYHsUOd3BZ3Qj5zKp9w6km6HsrjPk/TGZv0qMTWyWj0+1QOqpHQ2gZOLXaGA9Ekw==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.41.0.tgz",
+      "integrity": "sha512-xOxPJCnuktUkY2xoEZBKXO5DBCugFzjrVndKdUnyQr3+9aDWZReKq9MhaoVnbL+maVwWJu/N0SEtrtEUNb62QQ==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/types": "5.43.0",
-        "@typescript-eslint/visitor-keys": "5.43.0"
+        "@typescript-eslint/types": "5.41.0",
+        "@typescript-eslint/visitor-keys": "5.41.0"
       },
       "engines": {
         "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -1929,13 +1928,13 @@
       }
     },
     "node_modules/@typescript-eslint/type-utils": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.43.0.tgz",
-      "integrity": "sha512-K21f+KY2/VvYggLf5Pk4tgBOPs2otTaIHy2zjclo7UZGLyFH86VfUOm5iq+OtDtxq/Zwu2I3ujDBykVW4Xtmtg==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.41.0.tgz",
+      "integrity": "sha512-L30HNvIG6A1Q0R58e4hu4h+fZqaO909UcnnPbwKiN6Rc3BUEx6ez2wgN7aC0cBfcAjZfwkzE+E2PQQ9nEuoqfA==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/typescript-estree": "5.43.0",
-        "@typescript-eslint/utils": "5.43.0",
+        "@typescript-eslint/typescript-estree": "5.41.0",
+        "@typescript-eslint/utils": "5.41.0",
         "debug": "^4.3.4",
         "tsutils": "^3.21.0"
       },
@@ -1956,9 +1955,9 @@
       }
     },
     "node_modules/@typescript-eslint/types": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.43.0.tgz",
-      "integrity": "sha512-jpsbcD0x6AUvV7tyOlyvon0aUsQpF8W+7TpJntfCUWU1qaIKu2K34pMwQKSzQH8ORgUrGYY6pVIh1Pi8TNeteg==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.41.0.tgz",
+      "integrity": "sha512-5BejraMXMC+2UjefDvrH0Fo/eLwZRV6859SXRg+FgbhA0R0l6lDqDGAQYhKbXhPN2ofk2kY5sgGyLNL907UXpA==",
       "dev": true,
       "engines": {
         "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -1969,13 +1968,13 @@
       }
     },
     "node_modules/@typescript-eslint/typescript-estree": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.43.0.tgz",
-      "integrity": "sha512-BZ1WVe+QQ+igWal2tDbNg1j2HWUkAa+CVqdU79L4HP9izQY6CNhXfkNwd1SS4+sSZAP/EthI1uiCSY/+H0pROg==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.41.0.tgz",
+      "integrity": "sha512-SlzFYRwFSvswzDSQ/zPkIWcHv8O5y42YUskko9c4ki+fV6HATsTODUPbRbcGDFYP86gaJL5xohUEytvyNNcXWg==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/types": "5.43.0",
-        "@typescript-eslint/visitor-keys": "5.43.0",
+        "@typescript-eslint/types": "5.41.0",
+        "@typescript-eslint/visitor-keys": "5.41.0",
         "debug": "^4.3.4",
         "globby": "^11.1.0",
         "is-glob": "^4.0.3",
@@ -1996,16 +1995,16 @@
       }
     },
     "node_modules/@typescript-eslint/utils": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.43.0.tgz",
-      "integrity": "sha512-8nVpA6yX0sCjf7v/NDfeaOlyaIIqL7OaIGOWSPFqUKK59Gnumd3Wa+2l8oAaYO2lk0sO+SbWFWRSvhu8gLGv4A==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.41.0.tgz",
+      "integrity": "sha512-QlvfwaN9jaMga9EBazQ+5DDx/4sAdqDkcs05AsQHMaopluVCUyu1bTRUVKzXbgjDlrRAQrYVoi/sXJ9fmG+KLQ==",
       "dev": true,
       "dependencies": {
         "@types/json-schema": "^7.0.9",
         "@types/semver": "^7.3.12",
-        "@typescript-eslint/scope-manager": "5.43.0",
-        "@typescript-eslint/types": "5.43.0",
-        "@typescript-eslint/typescript-estree": "5.43.0",
+        "@typescript-eslint/scope-manager": "5.41.0",
+        "@typescript-eslint/types": "5.41.0",
+        "@typescript-eslint/typescript-estree": "5.41.0",
         "eslint-scope": "^5.1.1",
         "eslint-utils": "^3.0.0",
         "semver": "^7.3.7"
@@ -2022,12 +2021,12 @@
       }
     },
     "node_modules/@typescript-eslint/visitor-keys": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.43.0.tgz",
-      "integrity": "sha512-icl1jNH/d18OVHLfcwdL3bWUKsBeIiKYTGxMJCoGe7xFht+E4QgzOqoWYrU8XSLJWhVw8nTacbm03v23J/hFTg==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.41.0.tgz",
+      "integrity": "sha512-vilqeHj267v8uzzakbm13HkPMl7cbYpKVjgFWZPIOHIJHZtinvypUhJ5xBXfWYg4eFKqztbMMpOgFpT9Gfx4fw==",
       "dev": true,
       "dependencies": {
-        "@typescript-eslint/types": "5.43.0",
+        "@typescript-eslint/types": "5.41.0",
         "eslint-visitor-keys": "^3.3.0"
       },
       "engines": {
@@ -3431,13 +3430,10 @@
       }
     },
     "node_modules/esbuild-register": {
-      "version": "3.4.1",
-      "resolved": "https://registry.npmjs.org/esbuild-register/-/esbuild-register-3.4.1.tgz",
-      "integrity": "sha512-iCgs88/1wA5dIRx4i65eSjbkgrQQQJGpY6Z1eD2XPlzrSjbgNtfkw2/rfSMzJ4dTtlOD8EZTxrIA3fyYp0FsMA==",
+      "version": "3.3.3",
+      "resolved": "https://registry.npmjs.org/esbuild-register/-/esbuild-register-3.3.3.tgz",
+      "integrity": "sha512-eFHOkutgIMJY5gc8LUp/7c+LLlDqzNi9T6AwCZ2WKKl3HmT+5ef3ZRyPPxDOynInML0fgaC50yszPKfPnjC0NQ==",
       "dev": true,
-      "dependencies": {
-        "debug": "^4.3.4"
-      },
       "peerDependencies": {
         "esbuild": ">=0.12 <1"
       }
@@ -3614,9 +3610,9 @@
       }
     },
     "node_modules/eslint": {
-      "version": "8.27.0",
-      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.27.0.tgz",
-      "integrity": "sha512-0y1bfG2ho7mty+SiILVf9PfuRA49ek4Nc60Wmmu62QlobNR+CeXa4xXIJgcuwSQgZiWaPH+5BDsctpIW0PR/wQ==",
+      "version": "8.26.0",
+      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.26.0.tgz",
+      "integrity": "sha512-kzJkpaw1Bfwheq4VXUezFriD1GxszX6dUekM7Z3aC2o4hju+tsR/XyTC3RcoSD7jmy9VkPU3+N6YjVU2e96Oyg==",
       "dev": true,
       "dependencies": {
         "@eslint/eslintrc": "^1.3.3",
@@ -3782,9 +3778,9 @@
       }
     },
     "node_modules/eslint-plugin-github": {
-      "version": "4.4.1",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-github/-/eslint-plugin-github-4.4.1.tgz",
-      "integrity": "sha512-wpxUIPw+EK5bdUssB8W5Z9/tapZptfJuLkThwPY8p52v75MV/Fb1AkCrLGlYO0yi3mQGFoa3uE0NMzssVAFrUw==",
+      "version": "4.4.0",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-github/-/eslint-plugin-github-4.4.0.tgz",
+      "integrity": "sha512-jmVjy86WqVblKuvWnAQAEUMPZnAWbOUuV2hmAjQ54BvmukUW5PBml84NnyKe1QMt6k5a6JoIrbkLkyISTUDSxA==",
       "dev": true,
       "dependencies": {
         "@github/browserslist-config": "^1.0.0",
@@ -3875,9 +3871,9 @@
       "dev": true
     },
     "node_modules/eslint-plugin-jest": {
-      "version": "27.1.5",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-27.1.5.tgz",
-      "integrity": "sha512-CK2dekZ5VBdzsOSOH5Fc1rwC+cWXjkcyrmf1RV714nDUDKu+o73TTJiDxpbILG8PtPPpAAl3ywzh5QA7Ft0mjA==",
+      "version": "27.1.3",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-27.1.3.tgz",
+      "integrity": "sha512-7DrIfYRQPa7JQd1Le8G/BJsfYHVUKQdJQ/6vULSp/4NjKZmSMJ/605G2hhScEra++SiH68zPEjLnrO74nHrMLg==",
       "dev": true,
       "dependencies": {
         "@typescript-eslint/utils": "^5.10.0"
@@ -6281,12 +6277,6 @@
       "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==",
       "dev": true
     },
-    "node_modules/natural-compare-lite": {
-      "version": "1.4.0",
-      "resolved": "https://registry.npmjs.org/natural-compare-lite/-/natural-compare-lite-1.4.0.tgz",
-      "integrity": "sha512-Tj+HTDSJJKaZnfiuw+iaF9skdPpTo2GtEly5JHnWV/hfv2Qj/9RKsGISQtLh2ox3l5EAGw487hnBee0sIJ6v2g==",
-      "dev": true
-    },
     "node_modules/node-fetch": {
       "version": "2.6.7",
       "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
@@ -7782,9 +7772,9 @@
       }
     },
     "node_modules/typescript": {
-      "version": "4.9.3",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.3.tgz",
-      "integrity": "sha512-CIfGzTelbKNEnLpLdGFgdyKhG23CKdKgQPOBc+OUNrkJ2vr+KSzsSV5kq5iWhEQbok+quxgGzrAtGWCyU7tHnA==",
+      "version": "4.8.4",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.8.4.tgz",
+      "integrity": "sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==",
       "dev": true,
       "bin": {
         "tsc": "bin/tsc",
@@ -9602,9 +9592,9 @@
       "integrity": "sha512-ssE3Vlrys7sdIzs5LOxCzTVMsU7i9oa/IaW92wF32JFb3CVczqOkru2xspuKczHEbG3nvmPY7IFqVmGGHdNbYw=="
     },
     "@types/node": {
-      "version": "16.18.3",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-16.18.3.tgz",
-      "integrity": "sha512-jh6m0QUhIRcZpNv7Z/rpN+ZWXOicUUQbSoWks7Htkbb9IjFQj4kzcX/xFCkjstCj5flMsN8FiSvt+q+Tcs4Llg=="
+      "version": "16.18.2",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-16.18.2.tgz",
+      "integrity": "sha512-KIGQJyya+opDCFvDSZMNNS899ov5jlNdtN7PypgHWeb8e+5vWISdwTRo/ClsNVlmDihzOGqFyNBDamUs7TQQCA=="
     },
     "@types/prettier": {
       "version": "2.7.1",
@@ -9652,70 +9642,69 @@
       "dev": true
     },
     "@typescript-eslint/eslint-plugin": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.43.0.tgz",
-      "integrity": "sha512-wNPzG+eDR6+hhW4yobEmpR36jrqqQv1vxBq5LJO3fBAktjkvekfr4BRl+3Fn1CM/A+s8/EiGUbOMDoYqWdbtXA==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.41.0.tgz",
+      "integrity": "sha512-DXUS22Y57/LAFSg3x7Vi6RNAuLpTXwxB9S2nIA7msBb/Zt8p7XqMwdpdc1IU7CkOQUPgAqR5fWvxuKCbneKGmA==",
       "dev": true,
       "requires": {
-        "@typescript-eslint/scope-manager": "5.43.0",
-        "@typescript-eslint/type-utils": "5.43.0",
-        "@typescript-eslint/utils": "5.43.0",
+        "@typescript-eslint/scope-manager": "5.41.0",
+        "@typescript-eslint/type-utils": "5.41.0",
+        "@typescript-eslint/utils": "5.41.0",
         "debug": "^4.3.4",
         "ignore": "^5.2.0",
-        "natural-compare-lite": "^1.4.0",
         "regexpp": "^3.2.0",
         "semver": "^7.3.7",
         "tsutils": "^3.21.0"
       }
     },
     "@typescript-eslint/parser": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.43.0.tgz",
-      "integrity": "sha512-2iHUK2Lh7PwNUlhFxxLI2haSDNyXvebBO9izhjhMoDC+S3XI9qt2DGFUsiJ89m2k7gGYch2aEpYqV5F/+nwZug==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.41.0.tgz",
+      "integrity": "sha512-HQVfix4+RL5YRWZboMD1pUfFN8MpRH4laziWkkAzyO1fvNOY/uinZcvo3QiFJVS/siNHupV8E5+xSwQZrl6PZA==",
       "dev": true,
       "requires": {
-        "@typescript-eslint/scope-manager": "5.43.0",
-        "@typescript-eslint/types": "5.43.0",
-        "@typescript-eslint/typescript-estree": "5.43.0",
+        "@typescript-eslint/scope-manager": "5.41.0",
+        "@typescript-eslint/types": "5.41.0",
+        "@typescript-eslint/typescript-estree": "5.41.0",
         "debug": "^4.3.4"
       }
     },
     "@typescript-eslint/scope-manager": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.43.0.tgz",
-      "integrity": "sha512-XNWnGaqAtTJsUiZaoiGIrdJYHsUOd3BZ3Qj5zKp9w6km6HsrjPk/TGZv0qMTWyWj0+1QOqpHQ2gZOLXaGA9Ekw==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.41.0.tgz",
+      "integrity": "sha512-xOxPJCnuktUkY2xoEZBKXO5DBCugFzjrVndKdUnyQr3+9aDWZReKq9MhaoVnbL+maVwWJu/N0SEtrtEUNb62QQ==",
       "dev": true,
       "requires": {
-        "@typescript-eslint/types": "5.43.0",
-        "@typescript-eslint/visitor-keys": "5.43.0"
+        "@typescript-eslint/types": "5.41.0",
+        "@typescript-eslint/visitor-keys": "5.41.0"
       }
     },
     "@typescript-eslint/type-utils": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.43.0.tgz",
-      "integrity": "sha512-K21f+KY2/VvYggLf5Pk4tgBOPs2otTaIHy2zjclo7UZGLyFH86VfUOm5iq+OtDtxq/Zwu2I3ujDBykVW4Xtmtg==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.41.0.tgz",
+      "integrity": "sha512-L30HNvIG6A1Q0R58e4hu4h+fZqaO909UcnnPbwKiN6Rc3BUEx6ez2wgN7aC0cBfcAjZfwkzE+E2PQQ9nEuoqfA==",
       "dev": true,
       "requires": {
-        "@typescript-eslint/typescript-estree": "5.43.0",
-        "@typescript-eslint/utils": "5.43.0",
+        "@typescript-eslint/typescript-estree": "5.41.0",
+        "@typescript-eslint/utils": "5.41.0",
         "debug": "^4.3.4",
         "tsutils": "^3.21.0"
       }
     },
     "@typescript-eslint/types": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.43.0.tgz",
-      "integrity": "sha512-jpsbcD0x6AUvV7tyOlyvon0aUsQpF8W+7TpJntfCUWU1qaIKu2K34pMwQKSzQH8ORgUrGYY6pVIh1Pi8TNeteg==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.41.0.tgz",
+      "integrity": "sha512-5BejraMXMC+2UjefDvrH0Fo/eLwZRV6859SXRg+FgbhA0R0l6lDqDGAQYhKbXhPN2ofk2kY5sgGyLNL907UXpA==",
       "dev": true
     },
     "@typescript-eslint/typescript-estree": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.43.0.tgz",
-      "integrity": "sha512-BZ1WVe+QQ+igWal2tDbNg1j2HWUkAa+CVqdU79L4HP9izQY6CNhXfkNwd1SS4+sSZAP/EthI1uiCSY/+H0pROg==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.41.0.tgz",
+      "integrity": "sha512-SlzFYRwFSvswzDSQ/zPkIWcHv8O5y42YUskko9c4ki+fV6HATsTODUPbRbcGDFYP86gaJL5xohUEytvyNNcXWg==",
       "dev": true,
       "requires": {
-        "@typescript-eslint/types": "5.43.0",
-        "@typescript-eslint/visitor-keys": "5.43.0",
+        "@typescript-eslint/types": "5.41.0",
+        "@typescript-eslint/visitor-keys": "5.41.0",
         "debug": "^4.3.4",
         "globby": "^11.1.0",
         "is-glob": "^4.0.3",
@@ -9724,28 +9713,28 @@
       }
     },
     "@typescript-eslint/utils": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.43.0.tgz",
-      "integrity": "sha512-8nVpA6yX0sCjf7v/NDfeaOlyaIIqL7OaIGOWSPFqUKK59Gnumd3Wa+2l8oAaYO2lk0sO+SbWFWRSvhu8gLGv4A==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.41.0.tgz",
+      "integrity": "sha512-QlvfwaN9jaMga9EBazQ+5DDx/4sAdqDkcs05AsQHMaopluVCUyu1bTRUVKzXbgjDlrRAQrYVoi/sXJ9fmG+KLQ==",
       "dev": true,
       "requires": {
         "@types/json-schema": "^7.0.9",
         "@types/semver": "^7.3.12",
-        "@typescript-eslint/scope-manager": "5.43.0",
-        "@typescript-eslint/types": "5.43.0",
-        "@typescript-eslint/typescript-estree": "5.43.0",
+        "@typescript-eslint/scope-manager": "5.41.0",
+        "@typescript-eslint/types": "5.41.0",
+        "@typescript-eslint/typescript-estree": "5.41.0",
         "eslint-scope": "^5.1.1",
         "eslint-utils": "^3.0.0",
         "semver": "^7.3.7"
       }
     },
     "@typescript-eslint/visitor-keys": {
-      "version": "5.43.0",
-      "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.43.0.tgz",
-      "integrity": "sha512-icl1jNH/d18OVHLfcwdL3bWUKsBeIiKYTGxMJCoGe7xFht+E4QgzOqoWYrU8XSLJWhVw8nTacbm03v23J/hFTg==",
+      "version": "5.41.0",
+      "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.41.0.tgz",
+      "integrity": "sha512-vilqeHj267v8uzzakbm13HkPMl7cbYpKVjgFWZPIOHIJHZtinvypUhJ5xBXfWYg4eFKqztbMMpOgFpT9Gfx4fw==",
       "dev": true,
       "requires": {
-        "@typescript-eslint/types": "5.43.0",
+        "@typescript-eslint/types": "5.41.0",
         "eslint-visitor-keys": "^3.3.0"
       }
     },
@@ -10729,13 +10718,11 @@
       "peer": true
     },
     "esbuild-register": {
-      "version": "3.4.1",
-      "resolved": "https://registry.npmjs.org/esbuild-register/-/esbuild-register-3.4.1.tgz",
-      "integrity": "sha512-iCgs88/1wA5dIRx4i65eSjbkgrQQQJGpY6Z1eD2XPlzrSjbgNtfkw2/rfSMzJ4dTtlOD8EZTxrIA3fyYp0FsMA==",
+      "version": "3.3.3",
+      "resolved": "https://registry.npmjs.org/esbuild-register/-/esbuild-register-3.3.3.tgz",
+      "integrity": "sha512-eFHOkutgIMJY5gc8LUp/7c+LLlDqzNi9T6AwCZ2WKKl3HmT+5ef3ZRyPPxDOynInML0fgaC50yszPKfPnjC0NQ==",
       "dev": true,
-      "requires": {
-        "debug": "^4.3.4"
-      }
+      "requires": {}
     },
     "esbuild-sunos-64": {
       "version": "0.15.12",
@@ -10842,9 +10829,9 @@
       }
     },
     "eslint": {
-      "version": "8.27.0",
-      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.27.0.tgz",
-      "integrity": "sha512-0y1bfG2ho7mty+SiILVf9PfuRA49ek4Nc60Wmmu62QlobNR+CeXa4xXIJgcuwSQgZiWaPH+5BDsctpIW0PR/wQ==",
+      "version": "8.26.0",
+      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.26.0.tgz",
+      "integrity": "sha512-kzJkpaw1Bfwheq4VXUezFriD1GxszX6dUekM7Z3aC2o4hju+tsR/XyTC3RcoSD7jmy9VkPU3+N6YjVU2e96Oyg==",
       "dev": true,
       "requires": {
         "@eslint/eslintrc": "^1.3.3",
@@ -10994,9 +10981,9 @@
       }
     },
     "eslint-plugin-github": {
-      "version": "4.4.1",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-github/-/eslint-plugin-github-4.4.1.tgz",
-      "integrity": "sha512-wpxUIPw+EK5bdUssB8W5Z9/tapZptfJuLkThwPY8p52v75MV/Fb1AkCrLGlYO0yi3mQGFoa3uE0NMzssVAFrUw==",
+      "version": "4.4.0",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-github/-/eslint-plugin-github-4.4.0.tgz",
+      "integrity": "sha512-jmVjy86WqVblKuvWnAQAEUMPZnAWbOUuV2hmAjQ54BvmukUW5PBml84NnyKe1QMt6k5a6JoIrbkLkyISTUDSxA==",
       "dev": true,
       "requires": {
         "@github/browserslist-config": "^1.0.0",
@@ -11072,9 +11059,9 @@
       }
     },
     "eslint-plugin-jest": {
-      "version": "27.1.5",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-27.1.5.tgz",
-      "integrity": "sha512-CK2dekZ5VBdzsOSOH5Fc1rwC+cWXjkcyrmf1RV714nDUDKu+o73TTJiDxpbILG8PtPPpAAl3ywzh5QA7Ft0mjA==",
+      "version": "27.1.3",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-27.1.3.tgz",
+      "integrity": "sha512-7DrIfYRQPa7JQd1Le8G/BJsfYHVUKQdJQ/6vULSp/4NjKZmSMJ/605G2hhScEra++SiH68zPEjLnrO74nHrMLg==",
       "dev": true,
       "requires": {
         "@typescript-eslint/utils": "^5.10.0"
@@ -12854,12 +12841,6 @@
       "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==",
       "dev": true
     },
-    "natural-compare-lite": {
-      "version": "1.4.0",
-      "resolved": "https://registry.npmjs.org/natural-compare-lite/-/natural-compare-lite-1.4.0.tgz",
-      "integrity": "sha512-Tj+HTDSJJKaZnfiuw+iaF9skdPpTo2GtEly5JHnWV/hfv2Qj/9RKsGISQtLh2ox3l5EAGw487hnBee0sIJ6v2g==",
-      "dev": true
-    },
     "node-fetch": {
       "version": "2.6.7",
       "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
@@ -13929,9 +13910,9 @@
       }
     },
     "typescript": {
-      "version": "4.9.3",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.3.tgz",
-      "integrity": "sha512-CIfGzTelbKNEnLpLdGFgdyKhG23CKdKgQPOBc+OUNrkJ2vr+KSzsSV5kq5iWhEQbok+quxgGzrAtGWCyU7tHnA==",
+      "version": "4.8.4",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.8.4.tgz",
+      "integrity": "sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==",
       "dev": true
     },
     "unbox-primitive": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-review-action",
-  "version": "3.0.0",
+  "version": "2.5.1",
   "private": true,
   "description": "A GitHub Action for Dependency Review",
   "main": "lib/main.js",
@@ -40,21 +40,21 @@
   },
   "devDependencies": {
     "@types/jest": "^27.5.2",
-    "@types/node": "^16.18.3",
-    "@typescript-eslint/eslint-plugin": "^5.43.0",
-    "@typescript-eslint/parser": "^5.43.0",
+    "@types/node": "^16.18.2",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
     "@types/spdx-expression-parse": "^3.0.2",
     "@types/spdx-satisfies": "^0.1.0",
     "@vercel/ncc": "^0.34.0",
-    "esbuild-register": "^3.4.1",
-    "eslint": "^8.27.0",
-    "eslint-plugin-github": "^4.4.1",
-    "eslint-plugin-jest": "^27.1.5",
+    "esbuild-register": "^3.3.3",
+    "eslint": "^8.26.0",
+    "eslint-plugin-github": "^4.4.0",
+    "eslint-plugin-jest": "^27.1.3",
     "jest": "^27.5.1",
     "js-yaml": "^4.1.0",
     "nodemon": "^2.0.20",
     "prettier": "2.7.1",
     "ts-jest": "^27.1.4",
-    "typescript": "^4.9.3"
+    "typescript": "^4.8.4"
   }
 }

src/config.ts

@@ -3,57 +3,15 @@ import path from 'path'
 import YAML from 'yaml'
 import * as core from '@actions/core'
 import * as z from 'zod'
-import {ConfigurationOptions, ConfigurationOptionsSchema} from './schemas'
-import {isSPDXValid, octokitClient} from './utils'
+import {
+  ConfigurationOptions,
+  ConfigurationOptionsSchema,
+  SeveritySchema,
+  SCOPES
+} from './schemas'
+import {isSPDXValid} from './utils'
 
-type ConfigurationOptionsPartial = Partial<ConfigurationOptions>
-
-export async function readConfig(): Promise<ConfigurationOptions> {
-  const inlineConfig = readInlineConfig()
-
-  const configFile = getOptionalInput('config-file')
-  if (configFile !== undefined) {
-    const externalConfig = await readConfigFile(configFile)
-
-    return ConfigurationOptionsSchema.parse({
-      ...externalConfig,
-      ...inlineConfig
-    })
-  }
-
-  return ConfigurationOptionsSchema.parse(inlineConfig)
-}
-
-function readInlineConfig(): ConfigurationOptionsPartial {
-  const fail_on_severity = getOptionalInput('fail-on-severity')
-  const fail_on_scopes = parseList(getOptionalInput('fail-on-scopes'))
-  const allow_licenses = parseList(getOptionalInput('allow-licenses'))
-  const deny_licenses = parseList(getOptionalInput('deny-licenses'))
-  const allow_ghsas = parseList(getOptionalInput('allow-ghsas'))
-  const license_check = getOptionalBoolean('license-check')
-  const vulnerability_check = getOptionalBoolean('vulnerability-check')
-  const base_ref = getOptionalInput('base-ref')
-  const head_ref = getOptionalInput('head-ref')
-
-  validateLicenses('allow-licenses', allow_licenses)
-  validateLicenses('deny-licenses', deny_licenses)
-
-  const keys = {
-    fail_on_severity,
-    fail_on_scopes,
-    allow_licenses,
-    deny_licenses,
-    allow_ghsas,
-    license_check,
-    vulnerability_check,
-    base_ref,
-    head_ref
-  }
-
-  return Object.fromEntries(
-    Object.entries(keys).filter(([_, value]) => value !== undefined)
-  )
-}
+type licenseKey = 'allow-licenses' | 'deny-licenses'
 
 function getOptionalBoolean(name: string): boolean | undefined {
   const value = core.getInput(name)
@@ -74,114 +32,104 @@ function parseList(list: string | undefined): string[] | undefined {
 }
 
 function validateLicenses(
-  key: 'allow-licenses' | 'deny-licenses',
+  key: licenseKey,
   licenses: string[] | undefined
 ): void {
   if (licenses === undefined) {
     return
   }
-
   const invalid_licenses = licenses.filter(license => !isSPDXValid(license))
 
   if (invalid_licenses.length > 0) {
-    throw new Error(`Invalid license(s) in ${key}: ${invalid_licenses}`)
-  }
-}
-
-async function readConfigFile(
-  filePath: string
-): Promise<ConfigurationOptionsPartial> {
-  // match a remote config (e.g. 'owner/repo/filepath@someref')
-  const format = new RegExp(
-    '(?<owner>[^/]+)/(?<repo>[^/]+)/(?<path>[^@]+)@(?<ref>.*)'
-  )
-
-  let data: string
-  const pieces = format.exec(filePath)
-
-  try {
-    if (pieces?.groups && pieces.length === 5) {
-      data = await getRemoteConfig({
-        owner: pieces.groups.owner,
-        repo: pieces.groups.repo,
-        path: pieces.groups.path,
-        ref: pieces.groups.ref
-      })
-    } else {
-      data = fs.readFileSync(path.resolve(filePath), 'utf-8')
-    }
-    return parseConfigFile(data)
-  } catch (error) {
     throw new Error(
-      `Unable to fetch or parse config file: ${(error as Error).message}`
+      `Invalid license(s) in ${key}: ${invalid_licenses.join(', ')}`
     )
   }
 }
 
-function parseConfigFile(configData: string): ConfigurationOptionsPartial {
+export function readConfig(): ConfigurationOptions {
+  const externalConfig = getOptionalInput('config-file')
+  if (externalConfig !== undefined) {
+    const config = readConfigFile(externalConfig)
+    // the reasoning behind reading the inline config when an external
+    // config file is provided is that we still want to allow users to
+    // pass inline options in the presence of an external config file.
+    const inlineConfig = readInlineConfig()
+    // the external config takes precedence
+    return Object.assign({}, inlineConfig, config)
+  } else {
+    return readInlineConfig()
+  }
+}
+
+export function readInlineConfig(): ConfigurationOptions {
+  const fail_on_severity = SeveritySchema.parse(
+    getOptionalInput('fail-on-severity')
+  )
+  const fail_on_scopes = z
+    .array(z.enum(SCOPES))
+    .default(['runtime'])
+    .parse(parseList(getOptionalInput('fail-on-scopes')))
+
+  const allow_licenses = parseList(getOptionalInput('allow-licenses'))
+  const deny_licenses = parseList(getOptionalInput('deny-licenses'))
+
+  if (allow_licenses !== undefined && deny_licenses !== undefined) {
+    throw new Error("Can't specify both allow_licenses and deny_licenses")
+  }
+  validateLicenses('allow-licenses', allow_licenses)
+  validateLicenses('deny-licenses', deny_licenses)
+
+  const allow_ghsas = parseList(getOptionalInput('allow-ghsas'))
+
+  const license_check = z
+    .boolean()
+    .default(true)
+    .parse(getOptionalBoolean('license-check'))
+  const vulnerability_check = z
+    .boolean()
+    .default(true)
+    .parse(getOptionalBoolean('vulnerability-check'))
+  if (license_check === false && vulnerability_check === false) {
+    throw new Error("Can't disable both license-check and vulnerability-check")
+  }
+
+  const base_ref = getOptionalInput('base-ref')
+  const head_ref = getOptionalInput('head-ref')
+
+  return {
+    fail_on_severity,
+    fail_on_scopes,
+    allow_licenses,
+    deny_licenses,
+    allow_ghsas,
+    license_check,
+    vulnerability_check,
+    base_ref,
+    head_ref
+  }
+}
+
+export function readConfigFile(filePath: string): ConfigurationOptions {
+  let data
+
   try {
-    const data = YAML.parse(configData)
-
-    // These are the options that we support where the user can provide
-    // either a YAML list or a comma-separated string.
-    const listKeys = [
-      'allow-licenses',
-      'deny-licenses',
-      'fail-on-scopes',
-      'allow-ghsas'
-    ]
-
-    for (const key of Object.keys(data)) {
-      // strings can contain list values (e.g. 'MIT, Apache-2.0'). In this
-      // case we need to parse that into a list (e.g. ['MIT', 'Apache-2.0']).
-      if (listKeys.includes(key)) {
-        const val = data[key]
-
-        if (typeof val === 'string') {
-          data[key] = val.split(',').map(x => x.trim())
-        }
-      }
-
-      // perform SPDX validation
-      if (key === 'allow-licenses' || key === 'deny-licenses') {
-        validateLicenses(key, data[key])
-      }
-
-      // get rid of the ugly dashes from the actions conventions
-      if (key.includes('-')) {
-        data[key.replace(/-/g, '_')] = data[key]
-        delete data[key]
-      }
-    }
-    return data
-  } catch (error) {
+    data = fs.readFileSync(path.resolve(filePath), 'utf-8')
+  } catch (error: unknown) {
     throw error
   }
-}
+  data = YAML.parse(data)
 
-async function getRemoteConfig(configOpts: {
-  [key: string]: string
-}): Promise<string> {
-  try {
-    const {data} = await octokitClient(
-      'external-repo-token',
-      false
-    ).rest.repos.getContent({
-      mediaType: {
-        format: 'raw'
-      },
-      owner: configOpts.owner,
-      repo: configOpts.repo,
-      path: configOpts.path,
-      ref: configOpts.ref
-    })
-
-    // When using mediaType.format = 'raw', the response.data is a string
-    // but this is not reflected in the return type of getContent, so we're
-    // casting the return value to a string.
-    return z.string().parse(data as unknown)
-  } catch (error) {
-    core.debug(error as string)
-    throw new Error('Error fetching remote config file')
+  for (const key of Object.keys(data)) {
+    if (key === 'allow-licenses' || key === 'deny-licenses') {
+      validateLicenses(key, data[key])
+    }
+    // get rid of the ugly dashes from the actions conventions
+    if (key.includes('-')) {
+      data[key.replace(/-/g, '_')] = data[key]
+      delete data[key]
+    }
   }
+  const values = ConfigurationOptionsSchema.parse(data)
+  return values
 }

src/licenses.ts

@@ -1,6 +1,8 @@
+import * as core from '@actions/core'
 import spdxSatisfies from 'spdx-satisfies'
+import {Octokit} from 'octokit'
 import {Change, Changes} from './schemas'
-import {isSPDXValid, octokitClient} from './utils'
+import {isSPDXValid} from './utils'
 
 /**
  * Loops through a list of changes, filtering and returning the
@@ -74,11 +76,12 @@ const fetchGHLicense = async (
   owner: string,
   repo: string
 ): Promise<string | null> => {
+  const octokit = new Octokit({
+    auth: core.getInput('repo-token', {required: true})
+  })
+
   try {
-    const response = await octokitClient().rest.licenses.getForRepo({
-      owner,
-      repo
-    })
+    const response = await octokit.rest.licenses.getForRepo({owner, repo})
     return response.data.license?.spdx_id ?? null
   } catch (_) {
     return null

src/main.ts

@@ -18,7 +18,7 @@ import {groupDependenciesByManifest} from './utils'
 
 async function run(): Promise<void> {
   try {
-    const config = await readConfig()
+    const config = readConfig()
     const refs = getRefs(config, github.context)
 
     const changes = await dependencyGraph.compare({
@@ -28,7 +28,7 @@ async function run(): Promise<void> {
       headRef: refs.head
     })
 
-    const minSeverity = config.fail_on_severity
+    const minSeverity = config.fail_on_severity as Severity
     const scopedChanges = filterChangesByScopes(config.fail_on_scopes, changes)
     const filteredChanges = filterAllowedAdvisories(
       config.allow_ghsas,

src/schemas.ts

@@ -38,38 +38,20 @@ export const ConfigurationOptionsSchema = z
   .object({
     fail_on_severity: SeveritySchema,
     fail_on_scopes: z.array(z.enum(SCOPES)).default(['runtime']),
-    allow_licenses: z.array(z.string()).optional(),
-    deny_licenses: z.array(z.string()).optional(),
+    allow_licenses: z.array(z.string()).default([]),
+    deny_licenses: z.array(z.string()).default([]),
     allow_ghsas: z.array(z.string()).default([]),
     license_check: z.boolean().default(true),
     vulnerability_check: z.boolean().default(true),
-    config_file: z.string().optional(),
-    base_ref: z.string().optional(),
-    head_ref: z.string().optional()
-  })
-  .superRefine((config, context) => {
-    if (config.allow_licenses && config.deny_licenses) {
-      context.addIssue({
-        code: z.ZodIssueCode.custom,
-        message: 'You cannot specify both allow-licenses and deny-licenses'
-      })
-    }
-    if (config.allow_licenses && config.allow_licenses.length < 1) {
-      context.addIssue({
-        code: z.ZodIssueCode.custom,
-        message: 'You should provide at least one license in allow-licenses'
-      })
-    }
-    if (
-      config.license_check === false &&
-      config.vulnerability_check === false
-    ) {
-      context.addIssue({
-        code: z.ZodIssueCode.custom,
-        message: "Can't disable both license-check and vulnerability-check"
-      })
-    }
+    config_file: z.string().optional().default('false'),
+    base_ref: z.string(),
+    head_ref: z.string()
   })
+  .partial()
+  .refine(
+    obj => !(obj.allow_licenses && obj.deny_licenses),
+    'Your workflow file has both an allow_licenses list and deny_licenses list, but you can only set one or the other.'
+  )
 
 export const ChangesSchema = z.array(ChangeSchema)
 

src/utils.ts

@@ -1,5 +1,3 @@
-import * as core from '@actions/core'
-import {Octokit} from 'octokit'
 import spdxParse from 'spdx-expression-parse'
 import {Changes} from './schemas'
 
@@ -40,29 +38,3 @@ export function isSPDXValid(license: string): boolean {
     return false
   }
 }
-
-function isEnterprise(): boolean {
-  const serverUrl = new URL(
-    process.env['GITHUB_SERVER_URL'] ?? 'https://github.com'
-  )
-  return serverUrl.hostname.toLowerCase() !== 'github.com'
-}
-
-export function octokitClient(token = 'repo-token', required = true): Octokit {
-  const opts: Record<string, unknown> = {}
-
-  // auth is only added if token is present. For remote config files in public
-  // repos the token is optional, so it could be undefined.
-  const auth = core.getInput(token, {required})
-  if (auth !== undefined) {
-    opts['auth'] = auth
-  }
-
-  //baseUrl is required for GitHub Enterprise Server
-  //https://github.com/octokit/octokit.js/blob/9c8fa89d5b0bc4ddbd6dec638db00a2f6c94c298/README.md?plain=1#L196
-  if (isEnterprise()) {
-    opts['baseUrl'] = new URL('api/v3', process.env['GITHUB_SERVER_URL'])
-  }
-
-  return new Octokit(opts)
-}