temp home for ghes-related logic

.github/dependabot.yml

@@ -9,6 +9,3 @@ updates:
     directory: /
     schedule:
       interval: daily
-    ignore:
-      - dependency-name: '@types/node'
-        update-types: ['version-update:semver-major']

.github/dependency-review-config.yml

@@ -1 +0,0 @@
-fail-on-severity: low

.github/dependency-review.yml

@@ -0,0 +1,8 @@
+fail_on_severity: low
+allow_licenses:
+  - 'GPL 3.0'
+  - 'BSD 3 Clause'
+  - 'MIT'
+#deny_licenses:
+#  - "LGPL 2.0"
+#  - "BSD 2 Clause"

.github/workflows/ci.yml

@@ -1,42 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-    paths-ignore:
-      - '**.md'
-  pull_request:
-    paths-ignore:
-      - '**.md'
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: npm
-      - name: Install dependencies
-        run: npm ci --ignore-scripts
-      - name: Test
-        run: |
-          npm test
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: npm
-      - name: Install dependencies
-        run: npm ci --ignore-scripts
-      - name: Check format
-        run: |
-          npm run format-check
-      - name: Lint
-        run: |
-          npm run lint

.gitignore

@@ -1,5 +1,4 @@
 event.json
-.ruby-version
 
 # Dependency directory
 node_modules

.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
-}

.vscode/launch.json

@@ -1,13 +0,0 @@
-{
-    "version": "0.1.0",
-    "configurations": [
-        {
-            "name": "Debug Jest Tests",
-            "type": "node",
-            "request": "launch",
-            "runtimeArgs": ["--inspect-brk", "${workspaceRoot}/node_modules/.bin/jest", "--runInBand", "--coverage", "false"],
-            "console": "integratedTerminal",
-            "internalConsoleOptions": "neverOpen"
-        }
-    ]
-}

.vscode/settings.json

@@ -1,4 +0,0 @@
-{
-  "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode"
-}

CONTRIBUTING.md

@@ -73,40 +73,6 @@ Here are a few things you can do that will increase the likelihood of your pull
 - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
 - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 
-## Cutting a new release
-
-1. Update the version number in [package.json](https://github.com/actions/dependency-review-action/blob/main/package.json).
-1. Go to [Draft a new
-release](https://github.com/actions/dependency-review-action/releases/new)
-in the Releases page.
-2. Make sure that the `Publish this Action to the GitHub Marketplace`
-checkbox is enabled
-
-<img width="481" alt="Screenshot 2022-06-15 at 12 08 19" src="https://user-images.githubusercontent.com/2161/173822484-4b60d8b4-c674-4bff-b5ff-b0c4a3650ab7.png">
-
-3. Click "Choose a tag" and then "Create new tag", where the tag name
-will be your version prefixed by a `v` (e.g. `v1.2.3`).
-4. Use a version number for the release title (e.g. "1.2.3").
-
-<img width="700" alt="Screenshot 2022-06-15 at 12 08 36" src="https://user-images.githubusercontent.com/2161/173822548-33ab3432-d679-4dc1-adf8-b50fdaf47de3.png">
-
-5. Add your release notes. If this is a major version make sure to
-include a small description of the biggest changes in the new version.
-6. Click "Publish Release".
-
-You now have a tag and release using the semver version you used
-above. The last remaining thing to do is to move the dynamic version
-identifier to match the current SHA. This allows users to adopt a
-major version number (e.g. `v1`) in their workflows while
-automatically getting all the
-minor/patch updates.
-
-To do this just checkout `main`, force-create a new annotated tag, and push it:
-```
-git tag -fa v2 -m "Updating v2 to 2.3.4"
-git push origin v2 --force
-```
-
 ## Resources
 
 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)

README.md

@@ -1,22 +1,14 @@
 # dependency-review-action
 
-This action scans your pull requests for dependency changes, and will
-raise an error if any vulnerabilities or invalid licenses are being introduced. The action is supported by an [API endpoint](https://docs.github.com/en/rest/reference/dependency-graph#dependency-review) that diffs the dependencies between any two revisions.
+This action scans your pull requests for dependency changes and will raise an error if any new dependencies have existing vulnerabilities. The action is supported by an [API endpoint](https://docs.github.com/en/rest/reference/dependency-graph#dependency-review) that diffs the dependencies between any two revisions.
 
-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
+The action is available for all public repositories, as well as private repositories that have Github Advanced Security licensed. 
 
 <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
-
-<img src="https://user-images.githubusercontent.com/7847935/182871416-50332bbb-b279-4621-a136-ca72a4314301.png">
 
 ## Installation
 
-**Please keep in mind that you need a [GitHub Advanced Security](https://docs.github.com/en/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security) license if you're running this action on private repositories.**
-
 1. Add a new YAML workflow to your `.github/workflows` folder:
 
 ```yaml
@@ -33,265 +25,10 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v2
+        uses: actions/dependency-review-action@v1
 ```
 
-### GitHub Enterprise Server
-
-This action is available in Enterprise Server starting with version 3.6. Make sure
-[GitHub Advanced
-Security](https://docs.github.com/en/enterprise-server@3.6/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise)
-and [GitHub
-Connect](https://docs.github.com/en/enterprise-server@3.6/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)
-are enabled.
-
-You can use the same workflow as above, replacing the `runs-on` value
-with the label of any of your runners (the default label
-is `self-hosted`):
-
-```yaml
-# ...
-
-jobs:
-  dependency-review:
-    runs-on: self-hosted
-    steps:
-      - name: 'Checkout Repository'
-        uses: actions/checkout@v3
-      - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v2
-```
-
-## Configuration
-
-Configure this action by either using an external configuration file,
-or by inlining these options in your workflow file.
-
-## Configuration Options
-
-### config-file
-
-A string representing the path to an external configuraton 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 in this list. See "[Licenses](https://github.com/actions/dependency-review-action#licenses)".
-
-**Possible values**: Any `spdx_id` value(s) from
-https://docs.github.com/en/rest/licenses.
-
-**Inline example**: `allow-licenses: BSD-3-Clause, MIT`
-
-**YAML example**:
-
-```yaml
-allow-licenses:
-  - BSD-3-Clause
-  - MIT
-```
-
-### 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 `spdx_id` value(s) from
-https://docs.github.com/en/rest/licenses.
-
-**Inline example**: `deny-licenses: LGPL-2.0, BSD-2-Clause`
-
-**YAML example**:
-
-```yaml
-deny-licenses:
-  - LGPL-2.0
-  - BSD-2-Clause
-```
-
-### 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
-```
-
-### 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
-Action using your workflow file. Here's an example of what the full
-file would look like:
-
-```yaml
-name: 'Dependency Review'
-on: [pull_request]
-permissions:
-  contents: read
-jobs:
-  dependency-review:
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'Checkout Repository'
-        uses: actions/checkout@v3
-      - name: Dependency Review
-        uses: actions/dependency-review-action@v2
-        with:
-          fail-on-severity: moderate
-
-          # Use comma-separated names to pass list arguments:
-          deny-licenses: LGPL-2.0, BSD-2-Clause
-```
-
-### Vulnerability Severity
-
-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`.
-
-This example will only fail on pull requests with `critical` and `high` vulnerabilities:
-
-```yaml
-- name: Dependency Review
-  uses: actions/dependency-review-action@v2
-  with:
-    fail-on-severity: high
-```
-
-### 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
-- 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 the `spdx_id` field for every license you want
-to filter. 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, Apache-2.0
-```
-
-### Considerations
-
-- Checking for licenses is not supported on Enterprise Server.
-- 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
-
-The Dependency Review GitHub Action check will only block a pull request from being merged if the repository owner has required the check to pass before merging. For more information, see the [documentation on protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging).
+Please keep in mind that you need a GitHub Advanced Security license if you're running this Action on private repos.
 
 ## Getting help
 
@@ -300,10 +37,9 @@ issue](https://github.com/actions/dependency-review-action/issues/new/choose).
 
 ## Contributing
 
-We are grateful for any contributions made to this project.
+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
-
 This project is released under the [MIT License](https://github.com/actions/dependency-review-action/blob/main/LICENSE).

__tests__/config.test.ts

@@ -1,177 +1,18 @@
-import {expect, test, beforeEach} from '@jest/globals'
-import {readConfig, readConfigFile} from '../src/config'
-import {getRefs} from '../src/git-refs'
+import {expect, test} from '@jest/globals'
+import {readConfigFile} from '../src/config'
 
-// GitHub Action inputs come in the form of environment variables
-// with an INPUT prefix (e.g. INPUT_FAIL-ON-SEVERITY)
-function setInput(input: string, value: string) {
-  process.env[`INPUT_${input.toUpperCase()}`] = value
-}
-
-// We want a clean ENV before each test. We use `delete`
-// since we want `undefined` values and not empty strings.
-function clearInputs() {
-  const allowedOptions = [
-    'FAIL-ON-SEVERITY',
-    'FAIL-ON-SCOPES',
-    'ALLOW-LICENSES',
-    'DENY-LICENSES',
-    'ALLOW-GHSAS',
-    'CONFIG-FILE',
-    'BASE-REF',
-    'HEAD-REF'
-  ]
-
-  allowedOptions.forEach(option => {
-    delete process.env[`INPUT_${option.toUpperCase()}`]
-  })
-}
-
-beforeEach(() => {
-  clearInputs()
-})
-
-test('it defaults to low severity', async () => {
-  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 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 options = readConfig()
-
-  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')
-
-  expect(() => readConfig()).toThrow()
-})
-
-test('it raises an error when given an unknown severity', async () => {
-  setInput('fail-on-severity', '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(readConfig(), {
-    payload: {},
-    eventName: 'workflow_dispatch'
-  })
-  expect(refs.base).toEqual('a-custom-base-ref')
-  expect(refs.head).toEqual('a-custom-head-ref')
-})
-
-test('it raises an error when no refs are provided and the event is not a pull request', async () => {
-  const options = readConfig()
-  expect(() =>
-    getRefs(options, {
-      payload: {},
-      eventName: 'workflow_dispatch'
-    })
-  ).toThrow()
-})
-
-test('it reads an external config file', async () => {
+test('reads the config file', async () => {
   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 () => {
-  expect(() => readConfigFile('fixtures/i-dont-exist')).toThrow()
+test('the default config path handles .yml and .yaml', async () => {
+  expect(true).toEqual(true)
 })
 
-test('it parses options from both sources', async () => {
-  setInput('config-file', './__tests__/fixtures/config-allow-sample.yml')
-
-  let options = readConfig()
-  expect(options.fail_on_severity).toEqual('critical')
-
-  setInput('base-ref', 'a-custom-base-ref')
-  options = readConfig()
-  expect(options.base_ref).toEqual('a-custom-base-ref')
-})
-
-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'
-
-  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 options = readConfig()
-  expect(options.allow_licenses).toEqual(undefined)
-  expect(options.deny_licenses).toEqual(undefined)
-
-  setInput('config-file', './__tests__/fixtures/license-config-sample.yml')
-  options = readConfig()
+test('returns a default config when the config file was not found', async () => {
+  let options = readConfigFile('fixtures/i-dont-exist')
   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 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')
-  expect(() => readConfig()).toThrow()
-})
-
-test('it defaults to runtime scope', async () => {
-  const options = readConfig()
-  expect(options.fail_on_scopes).toEqual(['runtime'])
-})
-
-test('it parses custom scopes preference', async () => {
-  setInput('fail-on-scopes', 'runtime, development')
-  let options = readConfig()
-  expect(options.fail_on_scopes).toEqual(['runtime', 'development'])
-
-  clearInputs()
-  setInput('fail-on-scopes', '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')
-  expect(() => readConfig()).toThrow()
-})
-
-test('it defaults to an empty GHSA allowlist', async () => {
-  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 options = readConfig()
-  expect(options.allow_ghsas).toEqual([
-    'GHSA-abcd-1234-5679',
-    'GHSA-efgh-1234-5679'
-  ])
+  expect(options.allow_licenses).toEqual([])
 })

__tests__/filter.test.ts

@@ -1,10 +1,6 @@
 import {expect, test} from '@jest/globals'
 import {Change, Changes} from '../src/schemas'
-import {
-  filterChangesBySeverity,
-  filterChangesByScopes,
-  filterOutAllowedAdvisories
-} from '../src/filter'
+import {filterChangesBySeverity} from '../src/filter'
 
 let npmChange: Change = {
   manifest: 'package.json',
@@ -12,15 +8,14 @@ let npmChange: Change = {
   ecosystem: 'npm',
   name: 'Reeuhq',
   version: '1.0.2',
-  package_url: 'pkg:npm/reeuhq@1.0.2',
+  package_url: 'somepurl',
   license: 'MIT',
   source_repository_url: 'github.com/some-repo',
-  scope: 'runtime',
   vulnerabilities: [
     {
       severity: 'critical',
       advisory_ghsa_id: 'first-random_string',
-      advisory_summary: 'very dangerous',
+      advisory_summary: 'very dangerouns',
       advisory_url: 'github.com/future-funk'
     }
   ]
@@ -32,15 +27,14 @@ let rubyChange: Change = {
   ecosystem: 'rubygems',
   name: 'actionsomething',
   version: '3.2.0',
-  package_url: 'pkg:gem/actionsomething@3.2.0',
+  package_url: 'somerubypurl',
   license: 'BSD',
   source_repository_url: 'github.com/some-repo',
-  scope: 'development',
   vulnerabilities: [
     {
       severity: 'moderate',
       advisory_ghsa_id: 'second-random_string',
-      advisory_summary: 'not so dangerous',
+      advisory_summary: 'not so dangerouns',
       advisory_url: 'github.com/future-funk'
     },
     {
@@ -52,19 +46,6 @@ let rubyChange: Change = {
   ]
 }
 
-let noVulnNpmChange: Change = {
-  manifest: 'package.json',
-  change_type: 'added',
-  ecosystem: 'npm',
-  name: 'helpful',
-  version: '1.0.0',
-  package_url: 'pkg:npm/helpful@1.0.0',
-  license: 'MIT',
-  source_repository_url: 'github.com/some-repo',
-  scope: 'runtime',
-  vulnerabilities: []
-}
-
 test('it properly filters changes by severity', async () => {
   const changes = [npmChange, rubyChange]
   let result = filterChangesBySeverity('high', changes)
@@ -76,42 +57,3 @@ test('it properly filters changes by severity', async () => {
   result = filterChangesBySeverity('critical', changes)
   expect(changes).toEqual([npmChange, rubyChange])
 })
-
-test('it properly filters changes by scope', async () => {
-  const changes = [npmChange, rubyChange]
-
-  let result = filterChangesByScopes(['runtime'], changes)
-  expect(result).toEqual([npmChange])
-
-  result = filterChangesByScopes(['development'], changes)
-  expect(result).toEqual([rubyChange])
-
-  result = filterChangesByScopes(['runtime', 'development'], changes)
-  expect(result).toEqual([npmChange, rubyChange])
-})
-
-test('it properly filters changes with allowed vulnerabilities', async () => {
-  const changes = [npmChange, rubyChange, noVulnNpmChange]
-
-  let result = filterOutAllowedAdvisories(['notrealGHSAID'], changes)
-  expect(result).toEqual([npmChange, rubyChange, noVulnNpmChange])
-
-  result = filterOutAllowedAdvisories(['first-random_string'], changes)
-  expect(result).toEqual([rubyChange, noVulnNpmChange])
-
-  result = filterOutAllowedAdvisories(
-    ['second-random_string', 'third-random_string'],
-    changes
-  )
-  expect(result).toEqual([npmChange, noVulnNpmChange])
-
-  result = filterOutAllowedAdvisories(
-    ['first-random_string', 'second-random_string', 'third-random_string'],
-    changes
-  )
-  expect(result).toEqual([noVulnNpmChange])
-
-  // if we have a change with multiple vulnerabilities but only one is allowed, we still should not filter out that change
-  result = filterOutAllowedAdvisories(['second-random_string'], changes)
-  expect(result).toEqual([npmChange, rubyChange, noVulnNpmChange])
-})

__tests__/fixtures/conflictive-config.yml

@@ -1,2 +0,0 @@
-allow_licenses: []
-deny_licenses: []

__tests__/fixtures/invalid-severity-config.yml

@@ -1,3 +0,0 @@
-fail-on-severity: 'so many zombies'
-deny-licenses:
-  - MIT

__tests__/fixtures/license-config-sample.yml

@@ -1 +0,0 @@
-allow_licenses: ['MIT', 'GPL 2']

__tests__/fixtures/no-licenses-config.yml

@@ -1 +0,0 @@
-fail_on_severity: critical

__tests__/licenses.test.ts

@@ -1,100 +0,0 @@
-import {expect, test} from '@jest/globals'
-import {Change, Changes} from '../src/schemas'
-import {getDeniedLicenseChanges} from '../src/licenses'
-
-let npmChange: Change = {
-  manifest: 'package.json',
-  change_type: 'added',
-  ecosystem: 'npm',
-  name: 'Reeuhq',
-  version: '1.0.2',
-  package_url: 'pkg:npm/reeuhq@1.0.2',
-  license: 'MIT',
-  source_repository_url: 'github.com/some-repo',
-  scope: 'runtime',
-  vulnerabilities: [
-    {
-      severity: 'critical',
-      advisory_ghsa_id: 'first-random_string',
-      advisory_summary: 'very dangerous',
-      advisory_url: 'github.com/future-funk'
-    }
-  ]
-}
-
-let rubyChange: Change = {
-  change_type: 'added',
-  manifest: 'Gemfile.lock',
-  ecosystem: 'rubygems',
-  name: 'actionsomething',
-  version: '3.2.0',
-  package_url: 'pkg:gem/actionsomething@3.2.0',
-  license: 'BSD',
-  source_repository_url: 'github.com/some-repo',
-  scope: 'runtime',
-  vulnerabilities: [
-    {
-      severity: 'moderate',
-      advisory_ghsa_id: 'second-random_string',
-      advisory_summary: 'not so dangerous',
-      advisory_url: 'github.com/future-funk'
-    },
-    {
-      severity: 'low',
-      advisory_ghsa_id: 'third-random_string',
-      advisory_summary: 'dont page me',
-      advisory_url: 'github.com/future-funk'
-    }
-  ]
-}
-
-test('it fails if a license outside the allow list is found', async () => {
-  const changes: Changes = [npmChange, rubyChange]
-  const [invalidChanges, _] = getDeniedLicenseChanges(changes, {allow: ['BSD']})
-  expect(invalidChanges[0]).toBe(npmChange)
-})
-
-test('it fails if a license inside the deny list is found', async () => {
-  const changes: Changes = [npmChange, rubyChange]
-  const [invalidChanges] = getDeniedLicenseChanges(changes, {deny: ['BSD']})
-  expect(invalidChanges[0]).toBe(rubyChange)
-})
-
-// 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 fails all license checks when allow is provided an empty array', async () => {
-  const changes: Changes = [npmChange, rubyChange]
-  let [invalidChanges, _] = getDeniedLicenseChanges(changes, {
-    allow: [],
-    deny: ['BSD']
-  })
-  expect(invalidChanges.length).toBe(2)
-})
-
-test('it does not fail if a license outside the allow list is found in removed changes', async () => {
-  const changes: Changes = [
-    {...npmChange, change_type: 'removed'},
-    {...rubyChange, change_type: 'removed'}
-  ]
-  const [invalidChanges, _] = getDeniedLicenseChanges(changes, {allow: ['BSD']})
-  expect(invalidChanges).toStrictEqual([])
-})
-
-test('it does not fail if a license inside the deny list is found in removed changes', async () => {
-  const changes: Changes = [
-    {...npmChange, change_type: 'removed'},
-    {...rubyChange, change_type: 'removed'}
-  ]
-  const [invalidChanges, _] = getDeniedLicenseChanges(changes, {deny: ['BSD']})
-  expect(invalidChanges).toStrictEqual([])
-})
-
-test('it fails if a license outside the allow list is found in both of added and removed changes', async () => {
-  const changes: Changes = [
-    {...npmChange, change_type: 'removed'},
-    npmChange,
-    {...rubyChange, change_type: 'removed'}
-  ]
-  const [invalidChanges, _] = getDeniedLicenseChanges(changes, {allow: ['BSD']})
-  expect(invalidChanges).toStrictEqual([npmChange])
-})

action.yml

@@ -3,35 +3,9 @@ description: 'Prevent the introduction of dependencies with known vulnerabilitie
 author: 'GitHub'
 inputs:
   repo-token:
-    description: Token for the repository. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`.
+    description: 'Token for the repository. Can be passed in using `{{ secrets.GITHUB_TOKEN }}`.'
     required: false
     default: ${{ github.token }}
-  fail-on-severity:
-    description: Don't block PRs below this severity. Possible values are `low`, `moderate`, `high`, `critical`.
-    required: false
-    default: 'low'
-  fail-on-scopes:
-    description: Dependency scopes to block PRs on. Comma-separated list. Possible values are 'unknown', 'runtime', and 'development' (e.g. "runtime, development")
-    required: false
-    default: 'runtime'
-  base-ref:
-    description: The base 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
-  head-ref:
-    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 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")
-    required: false
-  deny-licenses:
-    description: Comma-separated list of forbidden licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")
-    required: false
-  allow-ghsas:
-    description: Comma-separated list of allowed Github Advisory IDs (e.g. "GHSA-abcd-1234-5679, GHSA-efgh-1234-5679")
-    required: false
 runs:
   using: 'node16'
   main: 'dist/index.js'

dist/licenses.txt

@@ -624,19 +624,6 @@ Permission to use, copy, modify, and/or distribute this software for any purpose
 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 
-uuid
-MIT
-The MIT License (MIT)
-
-Copyright (c) 2010-2020 Robert Kieffer and other contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
 webidl-conversions
 BSD-2-Clause
 # The BSD 2-Clause License

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-review-action",
-  "version": "2.4.0",
+  "version": "0.0.1",
   "private": true,
   "description": "A GitHub Action for Dependency Review",
   "main": "lib/main.js",
@@ -25,31 +25,30 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.10.0",
-    "@actions/github": "^5.1.1",
+    "@actions/core": "^1.8.2",
+    "@actions/github": "^5.0.3",
     "@octokit/plugin-retry": "^3.0.9",
-    "@octokit/request-error": "^3.0.1",
-    "ansi-styles": "^6.1.1",
-    "got": "^12.5.1",
-    "nodemon": "^2.0.20",
-    "spdx-satisfies": "^5.0.1",
-    "yaml": "^2.1.2",
-    "zod": "^3.19.1"
+    "@octokit/request-error": "^2.1.0",
+    "ansi-styles": "^6.1.0",
+    "got": "^12.1.0",
+    "nodemon": "^2.0.16",
+    "yaml": "^2.1.1",
+    "zod": "^3.17.3"
   },
   "devDependencies": {
-    "@types/node": "^16.11.63",
-    "@typescript-eslint/eslint-plugin": "^5.38.1",
-    "@typescript-eslint/parser": "^5.38.1",
+    "@types/node": "^17.0.40",
+    "@typescript-eslint/eslint-plugin": "^5.27.1",
+    "@typescript-eslint/parser": "^5.27.1",
     "@vercel/ncc": "^0.34.0",
     "esbuild-register": "^3.3.3",
-    "eslint": "^8.24.0",
-    "eslint-plugin-github": "^4.3.7",
-    "eslint-plugin-jest": "^27.0.4",
+    "eslint": "^8.17.0",
+    "eslint-plugin-github": "^4.3.6",
+    "eslint-plugin-jest": "^26.5.3",
     "jest": "^27.5.1",
     "js-yaml": "^4.1.0",
-    "nodemon": "^2.0.20",
-    "prettier": "2.7.1",
+    "nodemon": "^2.0.16",
+    "prettier": "2.6.2",
     "ts-jest": "^27.1.4",
-    "typescript": "^4.8.4"
+    "typescript": "^4.7.3"
   }
-}
+}

scripts/scan_pr

@@ -32,25 +32,17 @@ event_file = Tempfile.new
 event_file.write("{ \"pull_request\": #{pr.to_h.to_json}}")
 event_file.close
 
-action_inputs = {
-  "repo-token" => github_token
-}
-
 dev_cmd_env = {
+  "INPUT_REPO-TOKEN" => github_token,
   "GITHUB_REPOSITORY" => repo_nwo,
   "GITHUB_EVENT_NAME" => "pull_request",
-  "GITHUB_EVENT_PATH" => event_file.path,
-  "GITHUB_STEP_SUMMARY" => "/dev/null"
+  "GITHUB_EVENT_PATH" => event_file.path
 }
 
-# bash does not like variable names with dashes like the ones Actions
-# uses (e.g. INPUT_REPO-TOKEN). Passing them through `env` instead of
-# manually setting them does the job.
-action_inputs_env_str = action_inputs.map { |name, value| "\"INPUT_#{name.upcase}=#{value}\"" }.join(" ")
-dev_cmd = "./node_modules/.bin/nodemon --exec \"env #{action_inputs_env_str} node -r esbuild-register\" src/main.ts"
+dev_cmd = "./node_modules/.bin/nodemon --exec \"node -r esbuild-register\" src/main.ts"
 
 Open3.popen2e(dev_cmd_env, dev_cmd) do |stdin, out|
   while line = out.gets
-    puts line.gsub(github_token, "<REDACTED>")
+    puts line
   end
 end

src/config.ts

@@ -1,92 +1,33 @@
 import * as fs from 'fs'
-import path from 'path'
 import YAML from 'yaml'
-import * as core from '@actions/core'
-import * as z from 'zod'
-import {
-  ConfigurationOptions,
-  ConfigurationOptionsSchema,
-  SeveritySchema,
-  SCOPES
-} from './schemas'
+import {ConfigurationOptions, ConfigurationOptionsSchema} from './schemas'
+import path from 'path'
 
-function getOptionalInput(name: string): string | undefined {
-  const value = core.getInput(name)
-  return value.length > 0 ? value : undefined
-}
+export const CONFIG_FILEPATH = './.github/dependency-review.yml'
 
-function parseList(list: string | undefined): string[] | undefined {
-  if (list === undefined) {
-    return list
-  } else {
-    return list.split(',').map(x => x.trim())
-  }
-}
-
-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")
+export function readConfigFile(
+  filePath: string = CONFIG_FILEPATH
+): ConfigurationOptions {
+  // By default we want to fail on all severities and allow all licenses.
+  const defaultOptions: ConfigurationOptions = {
+    fail_on_severity: 'low',
+    allow_licenses: []
   }
 
-  const allow_ghsas = parseList(getOptionalInput('allow-ghsas'))
-
-  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,
-    base_ref,
-    head_ref
-  }
-}
-
-export function readConfigFile(filePath: string): ConfigurationOptions {
   let data
 
   try {
     data = fs.readFileSync(path.resolve(filePath), 'utf-8')
-  } catch (error: unknown) {
-    throw error
-  }
-  data = YAML.parse(data)
-
-  // get rid of the ugly dashes from the actions conventions
-  for (const key of Object.keys(data)) {
-    if (key.includes('-')) {
-      data[key.replace(/-/g, '_')] = data[key]
-      delete data[key]
+  } catch (error: any) {
+    if (error.code && error.code === 'ENOENT') {
+      return defaultOptions
+    } else {
+      throw error
     }
   }
-  const values = ConfigurationOptionsSchema.parse(data)
-  return values
+
+  const values = YAML.parse(data)
+  const parsed = ConfigurationOptionsSchema.parse(values)
+
+  return parsed
 }

src/filter.ts

@@ -1,4 +1,5 @@
-import {Changes, Severity, SEVERITIES, Scope} from './schemas'
+import {Changes} from './schemas'
+import {Severity, SEVERITIES} from './schemas'
 
 export function filterChangesBySeverity(
   severity: Severity,
@@ -6,7 +7,7 @@ export function filterChangesBySeverity(
 ): Changes {
   const severityIdx = SEVERITIES.indexOf(severity)
   let filteredChanges = []
-  for (const change of changes) {
+  for (let change of changes) {
     if (
       change === undefined ||
       change.vulnerabilities === undefined ||
@@ -15,7 +16,7 @@ export function filterChangesBySeverity(
       continue
     }
 
-    const fChange = {
+    let fChange = {
       ...change,
       vulnerabilities: change.vulnerabilities.filter(vuln => {
         const vulnIdx = SEVERITIES.indexOf(vuln.severity)
@@ -33,52 +34,3 @@ export function filterChangesBySeverity(
   )
   return filteredChanges
 }
-
-export function filterChangesByScopes(
-  scopes: Scope[] | undefined,
-  changes: Changes
-): Changes {
-  if (scopes === undefined) {
-    return []
-  }
-
-  const filteredChanges = changes.filter(change => {
-    // if there is no scope on the change (Enterprise Server API for now), we will assume it is a runtime scope
-    const scope = change.scope || 'runtime'
-    return scopes.includes(scope)
-  })
-
-  return filteredChanges
-}
-
-export function filterOutAllowedAdvisories(
-  ghsas: string[] | undefined,
-  changes: Changes
-): Changes {
-  if (ghsas === undefined) {
-    return []
-  }
-
-  const filteredChanges = changes.filter(change => {
-    const noAdvisories =
-      change.vulnerabilities === undefined ||
-      change.vulnerabilities.length === 0
-
-    if (noAdvisories) {
-      return true
-    }
-
-    let allAllowedAdvisories = true
-    // if there's at least one advisory that is not allowlisted, we will keep the change
-    for (const vulnerability of change.vulnerabilities) {
-      if (!ghsas.includes(vulnerability.advisory_ghsa_id)) {
-        allAllowedAdvisories = false
-      }
-      if (!allAllowedAdvisories) {
-        return true
-      }
-    }
-  })
-
-  return filteredChanges
-}

src/git-refs.ts

@@ -1,42 +0,0 @@
-import {PullRequestSchema, ConfigurationOptions} from './schemas'
-
-export function getRefs(
-  config: ConfigurationOptions,
-  context: {payload: {pull_request?: unknown}; eventName: string}
-): {base: string; head: string} {
-  let base_ref = config.base_ref
-  let head_ref = config.head_ref
-
-  // If possible, source default base & head refs from the GitHub event.
-  // The base/head ref from the config take priority, if provided.
-  if (
-    context.eventName === 'pull_request' ||
-    context.eventName === 'pull_request_target'
-  ) {
-    const pull_request = PullRequestSchema.parse(context.payload.pull_request)
-    base_ref = base_ref || pull_request.base.sha
-    head_ref = head_ref || pull_request.head.sha
-  }
-
-  if (!base_ref && !head_ref) {
-    throw new Error(
-      'Both a base ref and head ref must be provided, either via the `base_ref`/`head_ref` ' +
-        'config options, or by running a `pull_request`/`pull_request_target` workflow.'
-    )
-  } else if (!base_ref) {
-    throw new Error(
-      'A base ref must be provided, either via the `base_ref` config option, ' +
-        'or by running a `pull_request`/`pull_request_target` workflow.'
-    )
-  } else if (!head_ref) {
-    throw new Error(
-      'A head ref must be provided, either via the `head_ref` config option, ' +
-        'or by running a `pull_request`/`pull_request_target` workflow.'
-    )
-  }
-
-  return {
-    base: base_ref,
-    head: head_ref
-  }
-}

src/github.js

@@ -0,0 +1,134 @@
+"use strict";
+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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+exports.parseGitHubUrl = exports.getApiClient = exports.getPlatform = exports.GITHUB_DOTCOM_URL = exports.Platform = void 0;
+// Tons of code lifted from https://github.com/github/codeql-action!
+var path = require("path");
+var core = require("@actions/core");
+var githubUtils = require("@actions/github/lib/utils");
+var retry = require("@octokit/plugin-retry");
+var Platform;
+(function (Platform) {
+    Platform[Platform["DOTCOM"] = 0] = "DOTCOM";
+    Platform[Platform["GHES"] = 1] = "GHES";
+    Platform[Platform["GHAE"] = 2] = "GHAE";
+})(Platform = exports.Platform || (exports.Platform = {}));
+exports.GITHUB_DOTCOM_URL = 'https://github.com';
+var GITHUB_ENTERPRISE_VERSION_HEADER = 'x-github-enterprise-version';
+function getPlatform(url) {
+    return __awaiter(this, void 0, void 0, function () {
+        var apiClient, response;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    // We can avoid making an API request in the standard dotcom case
+                    if (parseGitHubUrl(url) === exports.GITHUB_DOTCOM_URL) {
+                        return [2 /*return*/, Platform.DOTCOM];
+                    }
+                    apiClient = (0, exports.getApiClient)(url);
+                    return [4 /*yield*/, apiClient.rest.meta.get()];
+                case 1:
+                    response = _a.sent();
+                    if (response.headers[GITHUB_ENTERPRISE_VERSION_HEADER] === 'GitHub AE') {
+                        return [2 /*return*/, Platform.GHAE];
+                    }
+                    return [2 /*return*/, Platform.GHES];
+            }
+        });
+    });
+}
+exports.getPlatform = getPlatform;
+var getApiClient = function (url) {
+    var auth = core.getInput('repo-token', { required: true });
+    var retryingOctokit = githubUtils.GitHub.plugin(retry.retry);
+    return new retryingOctokit(githubUtils.getOctokitOptions(auth, {
+        baseUrl: getApiUrl(url)
+    }));
+};
+exports.getApiClient = getApiClient;
+function getApiUrl(githubUrl) {
+    var url = new URL(githubUrl);
+    // If we detect this is trying to connect to github.com
+    // then return with a fixed canonical URL.
+    if (url.hostname === 'github.com' || url.hostname === 'api.github.com') {
+        return 'https://api.github.com';
+    }
+    // Add the /api/v3 API prefix
+    url.pathname = path.join(url.pathname, 'api', 'v3');
+    return url.toString();
+}
+/**
+ * Parses user input of a github.com or GHES URL to a canonical form.
+ * Removes any API prefix or suffix if one is present.
+ */
+function parseGitHubUrl(inputUrl) {
+    var originalUrl = inputUrl;
+    if (inputUrl.indexOf('://') === -1) {
+        inputUrl = "https://".concat(inputUrl);
+    }
+    if (!inputUrl.startsWith('http://') && !inputUrl.startsWith('https://')) {
+        throw new Error("\"".concat(originalUrl, "\" is not a http or https URL"));
+    }
+    var url;
+    try {
+        url = new URL(inputUrl);
+    }
+    catch (e) {
+        throw new Error("\"".concat(originalUrl, "\" is not a valid URL"));
+    }
+    // If we detect this is trying to be to github.com
+    // then return with a fixed canonical URL.
+    if (url.hostname === 'github.com' || url.hostname === 'api.github.com') {
+        return exports.GITHUB_DOTCOM_URL;
+    }
+    // Remove the API prefix if it's present
+    if (url.pathname.indexOf('/api/v3') !== -1) {
+        url.pathname = url.pathname.substring(0, url.pathname.indexOf('/api/v3'));
+    }
+    // Also consider subdomain isolation on GHES
+    if (url.hostname.startsWith('api.')) {
+        url.hostname = url.hostname.substring(4);
+    }
+    // Normalise path to having a trailing slash for consistency
+    if (!url.pathname.endsWith('/')) {
+        url.pathname = "".concat(url.pathname, "/");
+    }
+    return url.toString();
+}
+exports.parseGitHubUrl = parseGitHubUrl;
+getPlatform(exports.GITHUB_DOTCOM_URL);

src/licenses.ts

@@ -1,49 +0,0 @@
-import {Change} from './schemas'
-
-/**
- * Loops through a list of changes, filtering and returning the
- * ones that don't conform to the licenses allow/deny lists.
- *
- * Keep in mind that we don't let users specify both an allow and a deny
- * list in their config files, so this code works under the assumption that
- * one of the two list parameters will be empty. If both lists are provided,
- * we will ignore the deny list.
- * @param {Change[]} changes The list of changes to filter.
- * @param { { allow?: string[], deny?: string[]}} licenses An object with `allow`/`deny` keys, each containing a list of licenses.
- * @returns {[Array<Change>, Array<Change]} A tuple where the first element is the list of denied changes and the second one is the list of changes with unknown licenses
- */
-export function getDeniedLicenseChanges(
-  changes: Change[],
-  licenses: {
-    allow?: string[]
-    deny?: string[]
-  }
-): [Change[], Change[]] {
-  const {allow, deny} = licenses
-
-  const disallowed: Change[] = []
-  const unknown: Change[] = []
-
-  for (const change of changes) {
-    if (change.change_type === 'removed') {
-      continue
-    }
-
-    const license = change.license
-    if (license === null) {
-      unknown.push(change)
-      continue
-    }
-    if (allow !== undefined) {
-      if (!allow.includes(license)) {
-        disallowed.push(change)
-      }
-    } else if (deny !== undefined) {
-      if (deny.includes(license)) {
-        disallowed.push(change)
-      }
-    }
-  }
-
-  return [disallowed, unknown]
-}

src/main.ts

@@ -3,64 +3,56 @@ import * as dependencyGraph from './dependency-graph'
 import * as github from '@actions/github'
 import styles from 'ansi-styles'
 import {RequestError} from '@octokit/request-error'
-import {Change, Severity, Changes} from './schemas'
-import {readConfig} from '../src/config'
-import {
-  filterChangesBySeverity,
-  filterChangesByScopes,
-  filterOutAllowedAdvisories
-} from '../src/filter'
-import {getDeniedLicenseChanges} from './licenses'
-import * as summary from './summary'
-import {getRefs} from './git-refs'
-
-import {groupDependenciesByManifest} from './utils'
+import {Change, PullRequestSchema, Severity} from './schemas'
+import {readConfigFile} from '../src/config'
+import {filterChangesBySeverity} from '../src/filter'
 
 async function run(): Promise<void> {
   try {
-    const config = readConfig()
-    const refs = getRefs(config, github.context)
+    if (github.context.eventName !== 'pull_request') {
+      throw new Error(
+        `This run was triggered by the "${github.context.eventName}" event, which is unsupported. Please ensure you are using the "pull_request" event for this workflow.`
+      )
+    }
+
+    const pull_request = PullRequestSchema.parse(
+      github.context.payload.pull_request
+    )
 
     const changes = await dependencyGraph.compare({
       owner: github.context.repo.owner,
       repo: github.context.repo.repo,
-      baseRef: refs.base,
-      headRef: refs.head
+      baseRef: pull_request.base.sha,
+      headRef: pull_request.head.sha
     })
 
-    const minSeverity = config.fail_on_severity as Severity
-    const scopedChanges = filterChangesByScopes(config.fail_on_scopes, changes)
-    const filteredChanges = filterOutAllowedAdvisories(
-      config.allow_ghsas,
-      scopedChanges
+    let config = readConfigFile()
+    let minSeverity = config.fail_on_severity
+    let failed = false
+
+    let filteredChanges = filterChangesBySeverity(
+      minSeverity as Severity,
+      changes
     )
 
-    const addedChanges = filterChangesBySeverity(
-      minSeverity,
-      filteredChanges
-    ).filter(
-      change =>
+    for (const change of filteredChanges) {
+      if (
         change.change_type === 'added' &&
         change.vulnerabilities !== undefined &&
         change.vulnerabilities.length > 0
-    )
-
-    const [licenseErrors, unknownLicenses] = getDeniedLicenseChanges(
-      filteredChanges,
-      {
-        allow: config.allow_licenses,
-        deny: config.deny_licenses
+      ) {
+        printChangeVulnerabilities(change)
+        failed = true
       }
-    )
+    }
 
-    summary.addSummaryToSummary(addedChanges, licenseErrors, unknownLicenses)
-    summary.addChangeVulnerabilitiesToSummary(addedChanges, minSeverity)
-    summary.addLicensesToSummary(licenseErrors, unknownLicenses, config)
-    summary.addScannedDependencies(changes)
-
-    printVulnerabilitiesBlock(addedChanges, minSeverity)
-    printLicensesBlock(licenseErrors, unknownLicenses)
-    printScannedDependencies(changes)
+    if (failed) {
+      throw new Error('Dependency review detected vulnerable packages.')
+    } else {
+      core.info(
+        `Dependency review did not detect any vulnerable packages with severity level "${minSeverity}" or above.`
+      )
+    }
   } catch (error) {
     if (error instanceof RequestError && error.status === 404) {
       core.setFailed(
@@ -77,35 +69,10 @@ async function run(): Promise<void> {
         core.setFailed('Unexpected fatal error')
       }
     }
-  } finally {
-    await core.summary.write()
   }
 }
 
-function printVulnerabilitiesBlock(
-  addedChanges: Change[],
-  minSeverity: Severity
-): void {
-  let failed = false
-  core.group('Vulnerabilities', async () => {
-    if (addedChanges.length > 0) {
-      for (const change of addedChanges) {
-        printChangeVulnerabilities(change)
-      }
-      failed = true
-    }
-
-    if (failed) {
-      core.setFailed('Dependency review detected vulnerable packages.')
-    } else {
-      core.info(
-        `Dependency review did not detect any vulnerable packages with severity level "${minSeverity}" or higher.`
-      )
-    }
-  })
-}
-
-function printChangeVulnerabilities(change: Change): void {
+function printChangeVulnerabilities(change: Change) {
   for (const vuln of change.vulnerabilities) {
     core.info(
       `${styles.bold.open}${change.manifest} » ${change.name}@${
@@ -118,45 +85,6 @@ function printChangeVulnerabilities(change: Change): void {
   }
 }
 
-function printLicensesBlock(
-  licenseErrors: Change[],
-  unknownLicenses: Change[]
-): void {
-  core.group('Licenses', async () => {
-    if (licenseErrors.length > 0) {
-      printLicensesError(licenseErrors)
-      core.setFailed('Dependency review detected incompatible licenses.')
-    }
-    printNullLicenses(unknownLicenses)
-  })
-}
-
-function printLicensesError(changes: Change[]): void {
-  if (changes.length === 0) {
-    return
-  }
-
-  core.info('\nThe following dependencies have incompatible licenses:\n')
-  for (const change of changes) {
-    core.info(
-      `${styles.bold.open}${change.manifest} » ${change.name}@${change.version}${styles.bold.close} – License: ${styles.color.red.open}${change.license}${styles.color.red.close}`
-    )
-  }
-}
-
-function printNullLicenses(changes: Change[]): void {
-  if (changes.length === 0) {
-    return
-  }
-
-  core.info('\nWe could not detect a license for the following dependencies:\n')
-  for (const change of changes) {
-    core.info(
-      `${styles.bold.open}${change.manifest} » ${change.name}@${change.version}${styles.bold.close}`
-    )
-  }
-}
-
 function renderSeverity(
   severity: 'critical' | 'high' | 'moderate' | 'low'
 ): string {
@@ -171,42 +99,4 @@ function renderSeverity(
   return `${styles.color[color].open}(${severity} severity)${styles.color[color].close}`
 }
 
-function renderScannedDependency(change: Change): string {
-  const changeType: string = change.change_type
-
-  if (changeType !== 'added' && changeType !== 'removed') {
-    throw new Error(`Unexpected change type: ${changeType}`)
-  }
-
-  const color = (
-    {
-      added: 'green',
-      removed: 'red'
-    } as const
-  )[changeType]
-
-  const icon = (
-    {
-      added: '+',
-      removed: '-'
-    } as const
-  )[changeType]
-
-  return `${styles.color[color].open}${icon} ${change.manifest}@${change.version}${styles.color[color].close}`
-}
-
-function printScannedDependencies(changes: Changes): void {
-  core.group('Dependency Changes', async () => {
-    const dependencies = groupDependenciesByManifest(changes)
-
-    for (const manifestName of dependencies.keys()) {
-      const manifestChanges = dependencies.get(manifestName) || []
-      core.info(`File: ${styles.bold.open}${manifestName}${styles.bold.close}`)
-      for (const change of manifestChanges) {
-        core.info(`${renderScannedDependency(change)}`)
-      }
-    }
-  })
-}
-
 run()

src/schemas.ts

@@ -1,9 +1,6 @@
 import * as z from 'zod'
 
 export const SEVERITIES = ['critical', 'high', 'moderate', 'low'] as const
-export const SCOPES = ['unknown', 'runtime', 'development'] as const
-
-export const SeveritySchema = z.enum(SEVERITIES).default('low')
 
 export const ChangeSchema = z.object({
   change_type: z.enum(['added', 'removed']),
@@ -14,11 +11,10 @@ export const ChangeSchema = z.object({
   package_url: z.string(),
   license: z.string().nullable(),
   source_repository_url: z.string().nullable(),
-  scope: z.enum(SCOPES).optional(),
   vulnerabilities: z
     .array(
       z.object({
-        severity: SeveritySchema,
+        severity: z.enum(['critical', 'high', 'moderate', 'low']),
         advisory_ghsa_id: z.string(),
         advisory_summary: z.string(),
         advisory_url: z.string()
@@ -36,19 +32,14 @@ export const PullRequestSchema = z.object({
 
 export const ConfigurationOptionsSchema = z
   .object({
-    fail_on_severity: SeveritySchema,
-    fail_on_scopes: z.array(z.enum(SCOPES)).default(['runtime']),
+    fail_on_severity: z.enum(SEVERITIES).default('low'),
     allow_licenses: z.array(z.string()).default([]),
-    deny_licenses: z.array(z.string()).default([]),
-    allow_ghsas: z.array(z.string()).default([]),
-    config_file: z.string().optional().default('false'),
-    base_ref: z.string(),
-    head_ref: z.string()
+    deny_licenses: z.array(z.string()).default([])
   })
   .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.'
+    "Can't specify both allow_licenses and deny_licenses"
   )
 
 export const ChangesSchema = z.array(ChangeSchema)
@@ -56,5 +47,4 @@ export const ChangesSchema = z.array(ChangeSchema)
 export type Change = z.infer<typeof ChangeSchema>
 export type Changes = z.infer<typeof ChangesSchema>
 export type ConfigurationOptions = z.infer<typeof ConfigurationOptionsSchema>
-export type Severity = z.infer<typeof SeveritySchema>
-export type Scope = typeof SCOPES[number]
+export type Severity = typeof SEVERITIES[number]

src/summary.ts

@@ -1,171 +0,0 @@
-import * as core from '@actions/core'
-import {ConfigurationOptions, Change, Changes} from './schemas'
-import {SummaryTableRow} from '@actions/core/lib/summary'
-import {groupDependenciesByManifest, getManifestsSet, renderUrl} from './utils'
-
-export function addSummaryToSummary(
-  addedPackages: Changes,
-  licenseErrors: Change[],
-  unknownLicenses: Change[]
-): void {
-  core.summary
-    .addHeading('Dependency Review')
-    .addRaw(
-      `We found ${addedPackages.length} vulnerable package(s), ${licenseErrors.length} package(s) with incompatible licenses, and ${unknownLicenses.length} package(s) with unknown licenses.`
-    )
-}
-
-export function addChangeVulnerabilitiesToSummary(
-  addedPackages: Changes,
-  severity: string
-): void {
-  const rows: SummaryTableRow[] = []
-
-  const manifests = getManifestsSet(addedPackages)
-
-  core.summary
-    .addHeading('Vulnerabilities')
-    .addQuote(
-      `Vulnerabilites were filtered by mininum severity <strong>${severity}</strong>.`
-    )
-
-  if (addedPackages.length === 0) {
-    core.summary.addQuote('No vulnerabilities found in added packages.')
-    return
-  }
-
-  for (const manifest of manifests) {
-    for (const change of addedPackages.filter(
-      pkg => pkg.manifest === manifest
-    )) {
-      let previous_package = ''
-      let previous_version = ''
-      for (const vuln of change.vulnerabilities) {
-        const sameAsPrevious =
-          previous_package === change.name &&
-          previous_version === change.version
-
-        if (!sameAsPrevious) {
-          rows.push([
-            renderUrl(change.source_repository_url, change.name),
-            change.version,
-            renderUrl(vuln.advisory_url, vuln.advisory_summary),
-            vuln.severity
-          ])
-        } else {
-          rows.push([
-            {data: '', colspan: '2'},
-            renderUrl(vuln.advisory_url, vuln.advisory_summary),
-            vuln.severity
-          ])
-        }
-        previous_package = change.name
-        previous_version = change.version
-      }
-    }
-    core.summary.addHeading(`<em>${manifest}</em>`, 3).addTable([
-      [
-        {data: 'Name', header: true},
-        {data: 'Version', header: true},
-        {data: 'Vulnerability', header: true},
-        {data: 'Severity', header: true}
-      ],
-      ...rows
-    ])
-  }
-}
-
-export function addLicensesToSummary(
-  licenseErrors: Change[],
-  unknownLicenses: Change[],
-  config: ConfigurationOptions
-): void {
-  core.summary.addHeading('Licenses')
-
-  if (config.allow_licenses && config.allow_licenses.length > 0) {
-    core.summary.addQuote(
-      `<strong>Allowed Licenses</strong>: ${config.allow_licenses.join(', ')}`
-    )
-  }
-  if (config.deny_licenses && config.deny_licenses.length > 0) {
-    core.summary.addQuote(
-      `<strong>Denied Licenses</strong>: ${config.deny_licenses.join(', ')}`
-    )
-  }
-
-  if (licenseErrors.length === 0 && unknownLicenses.length === 0) {
-    core.summary.addQuote('No license violations detected.')
-    return
-  }
-
-  if (licenseErrors.length > 0) {
-    const rows: SummaryTableRow[] = []
-    const manifests = getManifestsSet(licenseErrors)
-
-    core.summary.addHeading('Incompatible Licenses', 3).addSeparator()
-
-    for (const manifest of manifests) {
-      core.summary.addHeading(`<em>${manifest}</em>`, 4)
-
-      for (const change of licenseErrors.filter(
-        pkg => pkg.manifest === manifest
-      )) {
-        rows.push([
-          renderUrl(change.source_repository_url, change.name),
-          change.version,
-          change.license || ''
-        ])
-      }
-      core.summary.addTable([['Package', 'Version', 'License'], ...rows])
-    }
-  } else {
-    core.summary.addQuote('No license violations detected.')
-  }
-
-  core.debug(`found ${unknownLicenses.length} unknown licenses`)
-
-  if (unknownLicenses.length > 0) {
-    const rows: SummaryTableRow[] = []
-    const manifests = getManifestsSet(unknownLicenses)
-
-    core.debug(
-      `found ${manifests.entries.length} manifests for unknown licenses`
-    )
-
-    core.summary.addHeading('Unknown Licenses', 3).addSeparator()
-
-    for (const manifest of manifests) {
-      core.summary.addHeading(`<em>${manifest}</em>`, 4)
-
-      for (const change of unknownLicenses.filter(
-        pkg => pkg.manifest === manifest
-      )) {
-        rows.push([
-          renderUrl(change.source_repository_url, change.name),
-          change.version
-        ])
-      }
-
-      core.summary.addTable([['Package', 'Version'], ...rows])
-    }
-  }
-}
-
-export function addScannedDependencies(changes: Changes): void {
-  const dependencies = groupDependenciesByManifest(changes)
-  const manifests = dependencies.keys()
-
-  const summary = core.summary
-    .addHeading('Scanned Dependencies')
-    .addRaw(`We scanned ${dependencies.size} manifest files:`)
-
-  for (const manifest of manifests) {
-    const deps = dependencies.get(manifest)
-    if (deps) {
-      const dependencyNames = deps.map(
-        dependency => `<li>${dependency.name}@${dependency.version}</li>`
-      )
-      summary.addRaw(`<h3>${manifest}</h3><ul>${dependencyNames.join('')}</ul>`)
-    }
-  }
-}

src/utils.ts

@@ -1,30 +0,0 @@
-import {Changes} from './schemas'
-
-export function groupDependenciesByManifest(
-  changes: Changes
-): Map<string, Changes> {
-  const dependencies: Map<string, Changes> = new Map()
-  for (const change of changes) {
-    const manifestName = change.manifest
-
-    if (dependencies.get(manifestName) === undefined) {
-      dependencies.set(manifestName, [])
-    }
-
-    dependencies.get(manifestName)?.push(change)
-  }
-
-  return dependencies
-}
-
-export function getManifestsSet(changes: Changes): Set<string> {
-  return new Set(changes.flatMap(c => c.manifest))
-}
-
-export function renderUrl(url: string | null, text: string): string {
-  if (url) {
-    return `<a href="${url}">${text}</a>`
-  } else {
-    return text
-  }
-}