Revert default values in action.yml to fix external configs.

Typo fixes in README

.devcontainer/devcontainer.json

@@ -0,0 +1,9 @@
+{
+  "name": "Dependency Review Action",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:18",
+  "postCreateCommand": "npm install",
+  "remoteUser": "node",
+  "features": {
+    "ghcr.io/devcontainers/features/ruby:1": {}
+  }
+}

.github/dependabot.yml

@@ -3,9 +3,12 @@ updates:
   - package-ecosystem: github-actions
     directory: /
     schedule:
-      interval: daily
+      interval: weekly
 
   - package-ecosystem: npm
     directory: /
     schedule:
-      interval: daily
+      interval: weekly
+    ignore:
+      - dependency-name: '@types/node'
+        update-types: ['version-update:semver-major']

.github/workflows/check-dist.yml

@@ -21,12 +21,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Set Node.js 16.x
-        uses: actions/setup-node@v3
+      - name: Set Node.js 20.x
+        uses: actions/setup-node@v4
         with:
-          node-version: 16.x
+          node-version: 20.x
+          cache: npm
 
       - name: Install dependencies
         run: npm ci
@@ -46,7 +47,7 @@ jobs:
         id: diff
 
       # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: dist

.github/workflows/ci.yml

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

.github/workflows/codeql.yml

@@ -0,0 +1,48 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '21 0 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: 'ubuntu-latest'
+    timeout-minutes: 360
+    permissions:
+      # required for all workflows
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript-typescript' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+        config: |
+          paths-ignore: 
+            - dist/index.js
+            - dist/sourcemap-register.js
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/dependency-review.yml

@@ -9,6 +9,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Dependency Review
         uses: actions/dependency-review-action@main

.github/workflows/stale.yaml

@@ -0,0 +1,28 @@
+name: Close stale PRs and Issues
+
+permissions:
+  issues: write
+  pull-requests: write
+
+on:
+  schedule:
+  - cron: "00 0 * * *" # runs at 00:00 daily
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/stale@v9.0.0
+      name: Clean up stale PRs and Issues
+      with:
+        stale-pr-message: "👋 This pull request has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the `Keep` label to hold stale off permanently, or do nothing. If you do nothing, this pull request will be closed eventually by the stale bot. Please see CONTRIBUTING.md for more policy details."
+        stale-pr-label: "Stale"
+        stale-issue-label: "Stale"
+        exempt-pr-labels: "Keep" # a "Keep" label will keep the PR from being closed as stale
+        exempt-issue-labels: "Keep" # a "Keep" label will keep the issue from being closed as stale
+        days-before-pr-stale: 180 # when the PR is considered stale
+        days-before-pr-close: 15 # when the PR is closed by the bot
+        days-before-issue-stale: 180 # when the issue is considered stale
+        days-before-issue-close: 15 # when the issue is closed by the bot
+        exempt-assignees: 'advanced-security-dependency-graph'
+        ascending: true

.gitignore

@@ -1,4 +1,5 @@
 event.json
+.ruby-version
 
 # Dependency directory
 node_modules
@@ -99,3 +100,5 @@ Thumbs.db
 # Ignore built ts files
 __tests__/runner/*
 lib/**/*
+
+tmp

.vscode/extensions.json

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

.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+    "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

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

CONTRIBUTING.md

@@ -1,4 +1,5 @@
 # Contributing
+
 [fork]: https://github.com/actions/dependency-review-action/fork
 [pr]: https://github.com/actions/dependency-review-action/compare
 [code-of-conduct]: CODE_OF_CONDUCT.md
@@ -9,7 +10,6 @@ Contributions to this project are
 [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license)
 to the public under the [project's open source license](LICENSE).
 
-
 Please note that this project is released with a [Contributor Code of
 Conduct][code-of-conduct]. By participating in this project you agree
 to abide by its terms.
@@ -20,7 +20,6 @@ This Action makes an authenticated query to the Dependency Graph Diff
 API endpoint (`GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}`)
 to find out the set of added and removed dependencies for each manifest.
 
-
 ### Bootstrapping the project
 
 ```
@@ -35,12 +34,17 @@ npm install
 npm run test
 ```
 
-*Note*: We don't have any useful tests yet, contributions are welcome!
+_Note_: We don't have any useful tests yet, contributions are welcome!
 
 ## Local Development
 
+It is recommended to have atleast [Node 18](https://nodejs.org/en/) installed.
 We have a script to scan a given PR for vulnerabilities, this will
-help you test your local changes. Make sure to [grab a Personal Access Token (PAT)](https://github.com/settings/tokens) before proceeding!
+help you test your local changes. Make sure to [grab a Personal Access Token (PAT)](https://github.com/settings/tokens) before proceeding (you'll need `repo` permissions for private repos):
+
+<img width="480" alt="Screenshot 2022-05-12 at 10 22 21" src="https://user-images.githubusercontent.com/2161/168026161-16788a0a-b6c8-428e-bb6a-83ea2a403070.png">
+
+The syntax of the script is:
 
 ```sh
 $ GITHUB_TOKEN=<token> ./scripts/scan_pr <pr_url>
@@ -52,22 +56,71 @@ Like this:
 $ GITHUB_TOKEN=my-secret-token ./scripts/scan_pr https://github.com/actions/dependency-review-action/pull/3
 ```
 
+[Configuration options](README.md#configuration-options) can be set by
+passing an external YAML [configuration file](README.md#configuration-file) to the
+`scan_pr` script with the `-c`/`--config-file` option:
+
+```sh
+$ GITHUB_TOKEN=<token> ./scripts/scan_pr --config-file my_custom_config.yml <pr_url>
+```
+
 ## Submitting a pull request
 
 0. [Fork][fork] and clone the repository
-0. Configure and install the dependencies: `npm install`
-0. Make sure the tests pass on your machine: `npm run test`
-0. Create a new branch: `git checkout -b my-branch-name`
-0. Make your change, add tests, and make sure the tests still pass
-0. Make sure to build and package before pushing: `npm run build && npm run package`
-0. Push to your fork and [submit a pull request][pr]
-0. Pat your self on the back and wait for your pull request to be reviewed and merged.
+1. Configure and install the dependencies: `npm install`
+2. Make sure the tests pass on your machine: `npm run test`
+3. Create a new branch: `git checkout -b my-branch-name`
+4. Make your change, add tests, and make sure the tests still pass
+5. Make sure to build and package before pushing: `npm run build && npm run package`
+6. Push to your fork and [submit a pull request][pr]
+7. Pat your self on the back and wait for your pull request to be reviewed and merged.
 
 Here are a few things you can do that will increase the likelihood of your pull request being accepted:
 
-- Write tests.
+- Add unit tests for new features.
 - 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).
+- Write a [good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+- Add examples of the usage to [examples.md](examples.md)
+- Link to a sample PR in a custom repository running your version of the Action.
+
+## 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.
+1. 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 v4 -m "Updating v4 to 4.0.1"
+git push origin v4 --force
+```
+
+## Stalebot
+
+We have begun using a [Stalebot action](https://github.com/actions/stale) to help keep the Issues and Pull requests backlogs tidy. You can see the configuration [here](.github/workflows/stalebot.yml). If you'd like to keep an issue open after getting a stalebot warning, simply comment on it and it'll reset the clock.
 
 ## Resources
 

README.md

@@ -1,14 +1,22 @@
 # dependency-review-action
 
-This Action scans your pull requests for vulnerabilities introduced
-when adding or updating your project's dependencies. A check in your 
-Pull Requests will let notify you of the results.
+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/rest/dependency-graph/dependency-review) that diffs the dependencies between any two revisions on your default branch.
 
-<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">
+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:
+
+<img width="850" alt="GitHub workflow run log showing Dependency Review job output" src="https://user-images.githubusercontent.com/2161/161042286-b22d7dd3-13cb-458d-8744-ce70ed9bf562.png">
+
+or on the job summary:
+
+<img width="850" alt="GitHub job summary showing Dependency Review output" src="https://github.com/actions/dependency-review-action/assets/2161/42fbed1d-64a7-42bf-9b05-c416bc67493f">
 
 ## Installation
 
+**Please keep in mind that you need a [GitHub Advanced Security](https://docs.github.com/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
@@ -23,21 +31,165 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v1
+        uses: actions/dependency-review-action@v4
 ```
 
+### GitHub Enterprise Server
+
+Make sure
+[GitHub Advanced
+Security](https://docs.github.com/enterprise-server@3.8/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise)
+and [GitHub
+Connect](https://docs.github.com/enterprise-server@3.8/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)
+are enabled, and that you have installed the [dependency-review-action](https://github.com/actions/dependency-review-action) on the server.
+
+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@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+```
+
+## Configuration options
+
+Configure this action by either inlining these options in your workflow file, or by using an external configuration file. All configuration options are optional.
+
+| 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`        |
+| `allow-dependencies-licenses`\*        | Contains a list of packages that will be excluded from license checks.                                                                                                                                  | Any package(s) in [purl](https://github.com/package-url/purl-spec) format                                    | none          |
+| `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          |
+| `comment-summary-in-pr`                | Enable or disable reporting the review summary as a comment in the pull request. If enabled, you must give the workflow or job the `pull-requests: write` permission.                                       | `always`, `on-failure`, `never`                                                                              | `never`       |
+| `deny-packages`                        | Any number of packages to block in a PR.                                                                                                                                                                | Package(s) in [purl](https://github.com/package-url/purl-spec) format                                        | empty         |
+| `deny-groups`                          | Any number of groups (namespaces) to block in a PR.                                                                                                                                                     | Namespace(s) in [purl](https://github.com/package-url/purl-spec) format (no package name, no version number) | empty         |
+| `retry-on-snapshot-warnings`\*         | Enable or disable retrying the action every 10 seconds while waiting for dependency submission actions to complete.                                                                                     | `true`, `false`                                                                                              | `false`       |
+| `retry-on-snapshot-warnings-timeout`\* | Maximum amount of time (in seconds) to retry the action while waiting for dependency submission actions to complete.                                                                                    | Any positive integer                                                                                         | 120           |
+| `warn-only`+                           | When set to `true`, the action will log all vulnerabilities as warnings regardless of the severity, and the action will complete with a `success` status. This overrides the `fail-on-severity` option. | `true`, `false`                                                                                              | `false`       |
+| `show-openssf-scorecard-levels`        | When set to `true`, the action will output information about all the known OpenSSF Scorecard scores for the dependencies changed in this pull request.                                                  | `true`, `false`                                                                                              | `true`        |
+| `warn-on-openssf-scorecard-level`      | When `show-openssf-scorecard-levels` is set to `true`, this option lets you configure the threshold for when a score is considered too low and gets a :warning: warning in the CI.                      | Any positive integer                                                                                         | 3             |
+
+\*not supported for use with GitHub Enterprise Server
+
++when `warn-only` is set to `true`, all vulnerabilities, independently of the severity, will be reported as warnings and the action will not fail.
+
+### Inline Configuration
+
+You can pass options to the Dependency Review GitHub Action using your workflow file.
+
+#### Example
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+permissions:
+  contents: read
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: Dependency Review
+        uses: actions/dependency-review-action@v4
+        with:
+          fail-on-severity: moderate
+
+          # Use comma-separated names to pass list arguments:
+          deny-licenses: LGPL-2.0, BSD-2-Clause
+```
+
+### Configuration File
+
+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.
+
+| 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:
+
+```yaml
+- name: Dependency Review
+  uses: actions/dependency-review-action@v4
+  with:
+    config-file: './.github/dependency-review-config.yml'
+```
+
+And then create the file in the path you just specified. Please note
+that the **option names in external files use underscores instead of dashes**:
+
+```yaml
+fail_on_severity: 'critical'
+allow_licenses:
+  - 'GPL-3.0'
+  - 'BSD-3-Clause'
+  - 'MIT'
+```
+
+For more examples of how to use this action and its configuration options, see the [examples](docs/examples.md) page.
+
+### Considerations
+
+- Checking for licenses is not supported on Enterprise Server as the API does not return license information.
+- The `allow-licenses` and `deny-licenses` options are mutually exclusive; 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**.
+
+## 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/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging).
+
+## Outputs
+
+- `comment-content` is generated with the same content as would be present in a Dependency Review Action comment.
+- `dependency-changes` holds all dependency changes in a JSON format. The following outputs are subsets of `dependency-changes` filtered based on the configuration:
+- `vulnerable-changes` holds information about dependency changes with vulnerable dependencies in a JSON format.
+- `invalid-license-changes` holds information about invalid or non-compliant license dependency changes in a JSON format.
+- `denied-changes` holds information about denied dependency changes in a JSON format.
+
+> [!NOTE]
+> Action outputs are unicode strings [with a 1MB size limit](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-docker-container-and-javascript-actions).
+
+> [!IMPORTANT]
+> If you use these outputs in a run-step, you must store the output data in an environment variable instead of using the output directly. Using an output directly might break shell scripts. For example:
+>
+> ```yaml
+> env:
+>   VULNERABLE_CHANGES: ${{ steps.review.outputs.vulnerable-changes }}
+> run: |
+>   echo "$VULNERABLE_CHANGES" | jq
+> ```
+>
+> instead of direct `echo '${{ steps.review.outputs.vulnerable-changes }}'`. See [examples](docs/examples.md) for more.
+
 ## 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
+
 This project is released under the [MIT License](https://github.com/actions/dependency-review-action/blob/main/LICENSE).

__tests__/config.test.ts

@@ -0,0 +1,204 @@
+import {expect, test, beforeEach} from '@jest/globals'
+import {readConfig} from '../src/config'
+import {getRefs} from '../src/git-refs'
+import * as Utils from '../src/utils'
+import {setInput, clearInputs} from './test-helpers'
+
+beforeAll(() => {
+  jest.spyOn(Utils, 'isSPDXValid').mockReturnValue(true)
+})
+
+beforeEach(() => {
+  clearInputs()
+})
+
+test('it defaults to low severity', async () => {
+  const config = await readConfig()
+  expect(config.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'])
+})
+
+test('it defaults to false for warn-only', async () => {
+  const config = await readConfig()
+  expect(config.warn_only).toEqual(false)
+})
+
+test('it defaults to empty allow/deny lists ', async () => {
+  const config = await readConfig()
+
+  expect(config.allow_licenses).toEqual(undefined)
+  expect(config.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'
+  )
+})
+
+test('it raises an error when given an unknown severity', async () => {
+  setInput('fail-on-severity', 'zombies')
+
+  await expect(readConfig()).rejects.toThrow(/received 'zombies'/)
+})
+
+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(), {
+    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 config = await readConfig()
+  expect(() =>
+    getRefs(config, {
+      payload: {},
+      eventName: 'workflow_dispatch'
+    })
+  ).toThrow()
+})
+
+test('it defaults to runtime scope', async () => {
+  const config = await readConfig()
+  expect(config.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'])
+
+  clearInputs()
+  setInput('fail-on-scopes', 'development')
+  config = await readConfig()
+  expect(config.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'/)
+})
+
+test('it defaults to an empty GHSA allowlist', async () => {
+  const config = await readConfig()
+  expect(config.allow_ghsas).toEqual([])
+})
+
+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([
+    '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)
+})
+
+test('it parses the license-check input', async () => {
+  setInput('license-check', 'false')
+  let config = await readConfig()
+  expect(config.license_check).toEqual(false)
+
+  clearInputs()
+  setInput('license-check', 'true')
+  config = await readConfig()
+  expect(config.license_check).toEqual(true)
+})
+
+test('it defaults to checking vulnerabilities', async () => {
+  const config = await readConfig()
+  expect(config.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)
+
+  clearInputs()
+  setInput('vulnerability-check', 'true')
+  config = await readConfig()
+  expect(config.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/
+  )
+})
+
+describe('licenses that are not valid SPDX licenses', () => {
+  beforeAll(() => {
+    jest.spyOn(Utils, 'isSPDXValid').mockReturnValue(false)
+  })
+
+  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'
+    )
+  })
+
+  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'
+    )
+  })
+})
+
+test('it parses the comment-summary-in-pr input', async () => {
+  setInput('comment-summary-in-pr', 'true')
+  let config = await readConfig()
+  expect(config.comment_summary_in_pr).toBe('always')
+
+  clearInputs()
+  setInput('comment-summary-in-pr', 'false')
+  config = await readConfig()
+  expect(config.comment_summary_in_pr).toBe('never')
+
+  clearInputs()
+  setInput('comment-summary-in-pr', 'always')
+  config = await readConfig()
+  expect(config.comment_summary_in_pr).toBe('always')
+
+  clearInputs()
+  setInput('comment-summary-in-pr', 'never')
+  config = await readConfig()
+  expect(config.comment_summary_in_pr).toBe('never')
+
+  clearInputs()
+  setInput('comment-summary-in-pr', 'on-failure')
+  config = await readConfig()
+  expect(config.comment_summary_in_pr).toBe('on-failure')
+})

__tests__/deny.test.ts

@@ -0,0 +1,166 @@
+import {expect, jest, test} from '@jest/globals'
+import {Change, Changes} from '../src/schemas'
+
+let getDeniedChanges: Function
+
+const 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'
+    }
+  ]
+}
+
+const 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'
+    }
+  ]
+}
+
+const pipChange: Change = {
+  change_type: 'added',
+  manifest: 'requirements.txt',
+  ecosystem: 'pip',
+  name: 'package-1',
+  version: '1.1.1',
+  package_url: 'pkg:pypi/package-1@1.1.1',
+  license: 'MIT',
+  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'
+    }
+  ]
+}
+
+const mvnChange: Change = {
+  change_type: 'added',
+  manifest: 'pom.xml',
+  ecosystem: 'maven',
+  name: 'org.apache.logging.log4j:log4j-core',
+  version: '2.15.0',
+  package_url: 'pkg:maven/org.apache.logging.log4j/log4j-core@2.14.7',
+  license: 'Apache-2.0',
+  source_repository_url:
+    'https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core',
+  scope: 'unknown',
+  vulnerabilities: [
+    {
+      severity: 'critical',
+      advisory_ghsa_id: 'second-random_string',
+      advisory_summary: 'not so dangerous',
+      advisory_url: 'github.com/future-funk'
+    }
+  ]
+}
+
+jest.mock('@actions/core')
+
+const mockOctokit = {
+  rest: {
+    licenses: {
+      getForRepo: jest
+        .fn()
+        .mockReturnValue({data: {license: {spdx_id: 'AGPL'}}})
+    }
+  }
+}
+
+jest.mock('octokit', () => {
+  return {
+    // eslint-disable-next-line @typescript-eslint/no-extraneous-class
+    Octokit: class {
+      constructor() {
+        return mockOctokit
+      }
+    }
+  }
+})
+
+beforeEach(async () => {
+  jest.resetModules()
+  jest.doMock('spdx-satisfies', () => {
+    // mock spdx-satisfies return value
+    // true for BSD, false for all others
+    return jest.fn((license: string, _: string): boolean => license === 'BSD')
+  })
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
+  ;({getDeniedChanges} = require('../src/deny'))
+})
+
+test('it adds packages in the deny packages list', async () => {
+  const changes: Changes = [npmChange, rubyChange]
+  const deniedChanges = await getDeniedChanges(
+    changes,
+    ['pkg:gem/actionsomething'],
+    []
+  )
+
+  expect(deniedChanges[0]).toBe(rubyChange)
+  expect(deniedChanges.length).toEqual(1)
+})
+
+test('it adds packages in the deny group list', async () => {
+  const changes: Changes = [mvnChange, rubyChange]
+  const deniedChanges = await getDeniedChanges(
+    changes,
+    [],
+    ['pkg:maven/org.apache.logging.log4j']
+  )
+
+  expect(deniedChanges[0]).toBe(mvnChange)
+  expect(deniedChanges.length).toEqual(1)
+})
+
+test('it adds packages outside of the deny lists', async () => {
+  const changes: Changes = [npmChange, pipChange]
+  const deniedChanges = await getDeniedChanges(
+    changes,
+    ['pkg:gem/actionsomething'],
+    ['pkg:maven:org.apache.logging.log4j']
+  )
+
+  expect(deniedChanges.length).toEqual(0)
+})

__tests__/dependency-graph.test.ts

@@ -0,0 +1,29 @@
+import {RequestError} from '@octokit/request-error'
+import * as dependencyGraph from '../src/dependency-graph'
+import * as core from '@actions/core'
+
+// mock call to core.getInput('repo-token'.. to avoid environment setup - Input required and not supplied: repo-token
+jest.mock('@actions/core', () => ({
+  getInput: (input: string) => {
+    if (input === 'repo-token') {
+      return 'gh_testtoken'
+    }
+  }
+}))
+
+test('it properly catches RequestError type', async () => {
+  const token = core.getInput('repo-token', {required: true})
+  expect(token).toBe('gh_testtoken')
+
+  //Integration test to make an API request using current dependencies and ensure response can parse into RequestError
+  try {
+    await dependencyGraph.compare({
+      owner: 'actions',
+      repo: 'dependency-review-action',
+      baseRef: 'refs/heads/master',
+      headRef: 'refs/heads/master'
+    })
+  } catch (error) {
+    expect(error).toBeInstanceOf(RequestError)
+  }
+})

__tests__/external-config.test.ts

@@ -0,0 +1,111 @@
+import {expect, test, beforeEach} from '@jest/globals'
+import {readConfig} from '../src/config'
+import * as Utils from '../src/utils'
+import {setInput, clearInputs} from './test-helpers'
+
+const externalConfig = `fail_on_severity: 'high'
+allow_licenses: ['GPL-2.0-only']
+`
+const mockOctokit = {
+  rest: {
+    repos: {
+      getContent: jest.fn().mockReturnValue({data: externalConfig})
+    }
+  }
+}
+
+jest.mock('octokit', () => {
+  return {
+    // eslint-disable-next-line @typescript-eslint/no-extraneous-class
+    Octokit: class {
+      constructor() {
+        return mockOctokit
+      }
+    }
+  }
+})
+
+beforeAll(() => {
+  jest.spyOn(Utils, 'isSPDXValid').mockReturnValue(true)
+})
+
+beforeEach(() => {
+  clearInputs()
+})
+
+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'])
+})
+
+test('raises an error when the config file was not found', async () => {
+  setInput('config-file', 'fixtures/i-dont-exist')
+  await expect(readConfig()).rejects.toThrow(/Unable to fetch/)
+})
+
+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')
+
+  setInput('base-ref', 'a-custom-base-ref')
+  config = await readConfig()
+  expect(config.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')
+  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')
+})
+
+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)
+
+  setInput('config-file', './__tests__/fixtures/license-config-sample.yml')
+  config = await readConfig()
+  expect(config.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')
+})
+
+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()
+})
+
+test('it supports comma-separated lists', async () => {
+  setInput(
+    'config-file',
+    './__tests__/fixtures/inline-license-config-sample.yml'
+  )
+  const config = await readConfig()
+
+  expect(config.allow_licenses).toEqual(['MIT', 'GPL-2.0-only'])
+})
+
+test('it reads a config file hosted in another repo', async () => {
+  setInput(
+    'config-file',
+    'future-funk/anyone-cualkiera/external-config.yml@main'
+  )
+  setInput('external-repo-token', 'gh_viptoken')
+
+  const config = await readConfig()
+
+  expect(config.fail_on_severity).toEqual('high')
+  expect(config.allow_licenses).toEqual(['GPL-2.0-only'])
+})

__tests__/filter.test.ts

@@ -0,0 +1,217 @@
+import {expect, test} from '@jest/globals'
+import {Change} from '../src/schemas'
+import {
+  filterChangesBySeverity,
+  filterChangesByScopes,
+  filterAllowedAdvisories
+} from '../src/filter'
+
+const 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: 'vulnerable-ghsa-id',
+      advisory_summary: 'very dangerous',
+      advisory_url: 'github.com/future-funk'
+    }
+  ]
+}
+
+const 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: 'development',
+  vulnerabilities: [
+    {
+      severity: 'moderate',
+      advisory_ghsa_id: 'moderate-ghsa-id',
+      advisory_summary: 'not so dangerous',
+      advisory_url: 'github.com/future-funk'
+    },
+    {
+      severity: 'low',
+      advisory_ghsa_id: 'low-ghsa-id',
+      advisory_summary: 'dont page me',
+      advisory_url: 'github.com/future-funk'
+    }
+  ]
+}
+
+const 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: []
+}
+
+const lodashChange: Change = {
+  change_type: 'added',
+  manifest: 'package.json',
+  ecosystem: 'npm',
+  name: 'lodash',
+  version: '4.17.0',
+  package_url: 'pkg:npm/lodash@4.17.0',
+  license: 'MIT',
+  source_repository_url: 'https://github.com/lodash/lodash',
+  scope: 'runtime',
+  vulnerabilities: [
+    {
+      severity: 'critical',
+      advisory_ghsa_id: 'GHSA-jf85-cpcp-j695',
+      advisory_summary: 'Prototype Pollution in lodash',
+      advisory_url: 'https://github.com/advisories/GHSA-jf85-cpcp-j695'
+    },
+    {
+      severity: 'high',
+      advisory_ghsa_id: 'GHSA-4xc9-xhrj-v574',
+      advisory_summary: 'Prototype Pollution in lodash',
+      advisory_url: 'https://github.com/advisories/GHSA-4xc9-xhrj-v574'
+    },
+    {
+      severity: 'high',
+      advisory_ghsa_id: 'GHSA-35jh-r3h4-6jhm',
+      advisory_summary: 'Command Injection in lodash',
+      advisory_url: 'https://github.com/advisories/GHSA-35jh-r3h4-6jhm'
+    },
+    {
+      severity: 'high',
+      advisory_ghsa_id: 'GHSA-p6mc-m468-83gw',
+      advisory_summary: 'Prototype Pollution in lodash',
+      advisory_url: 'https://github.com/advisories/GHSA-p6mc-m468-83gw'
+    },
+    {
+      severity: 'moderate',
+      advisory_ghsa_id: 'GHSA-x5rq-j2xg-h7qm',
+      advisory_summary:
+        'Regular Expression Denial of Service (ReDoS) in lodash',
+      advisory_url: 'https://github.com/advisories/GHSA-x5rq-j2xg-h7qm'
+    },
+    {
+      severity: 'moderate',
+      advisory_ghsa_id: 'GHSA-29mw-wpgm-hmr9',
+      advisory_summary:
+        'Regular Expression Denial of Service (ReDoS) in lodash',
+      advisory_url: 'https://github.com/advisories/GHSA-29mw-wpgm-hmr9'
+    },
+    {
+      severity: 'low',
+      advisory_ghsa_id: 'GHSA-fvqr-27wr-82fm',
+      advisory_summary: 'Prototype Pollution in lodash',
+      advisory_url: 'https://github.com/advisories/GHSA-fvqr-27wr-82fm'
+    }
+  ]
+}
+
+test('it properly filters changes by severity', async () => {
+  const changes = [npmChange, rubyChange]
+  let result = filterChangesBySeverity('high', changes)
+  expect(result).toEqual([npmChange])
+
+  result = filterChangesBySeverity('low', changes)
+  expect(changes).toEqual([npmChange, rubyChange])
+
+  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 handles undefined advisory IDs', async () => {
+  const changes = [npmChange, rubyChange, noVulnNpmChange]
+  const result = filterAllowedAdvisories(undefined, changes)
+  expect(result).toEqual([npmChange, rubyChange, noVulnNpmChange])
+})
+
+test('it properly filters changes with allowed vulnerabilities', async () => {
+  const changes = [npmChange, rubyChange, noVulnNpmChange]
+
+  const fakeGHSAChanges = filterAllowedAdvisories(['notrealGHSAID'], changes)
+  expect(fakeGHSAChanges).toEqual([npmChange, rubyChange, noVulnNpmChange])
+})
+
+test('it properly filters only allowed vulnerabilities', async () => {
+  const changes = [npmChange, rubyChange, noVulnNpmChange]
+  const oldVulns = [
+    ...npmChange.vulnerabilities,
+    ...rubyChange.vulnerabilities,
+    ...noVulnNpmChange.vulnerabilities
+  ]
+
+  const vulnerable = filterAllowedAdvisories(['vulnerable-ghsa-id'], changes)
+
+  const newVulns = vulnerable.map(change => change.vulnerabilities).flat()
+
+  expect(newVulns.length).toEqual(oldVulns.length - 1)
+  expect(newVulns).not.toContainEqual(
+    expect.objectContaining({advisory_ghsa_id: 'vulnerable-ghsa-id'})
+  )
+})
+
+test('does not drop dependencies when filtering by GHSA', async () => {
+  const changes = [npmChange, rubyChange, noVulnNpmChange]
+  const result = filterAllowedAdvisories(
+    ['moderate-ghsa-id', 'low-ghsa-id', 'GHSA-jf85-cpcp-j695'],
+    changes
+  )
+
+  expect(result.map(change => change.name)).toEqual(
+    changes.map(change => change.name)
+  )
+})
+
+test('it properly filters multiple GHSAs', async () => {
+  const allowedGHSAs = ['vulnerable-ghsa-id', 'moderate-ghsa-id', 'low-ghsa-id']
+  const changes = [npmChange, rubyChange, noVulnNpmChange]
+  const oldVulns = changes.map(change => change.vulnerabilities).flat()
+
+  const result = filterAllowedAdvisories(allowedGHSAs, changes)
+
+  const newVulns = result.map(change => change.vulnerabilities).flat()
+
+  expect(newVulns.length).toEqual(oldVulns.length - 3)
+})
+
+test('it filters out GHSA dependencies', async () => {
+  const lodash = filterAllowedAdvisories(
+    ['GHSA-jf85-cpcp-j695'],
+    [lodashChange]
+  )[0]
+  // the filter should have removed a single GHSA from the list
+  const expected = lodashChange.vulnerabilities.filter(
+    vuln => vuln.advisory_ghsa_id !== 'GHSA-jf85-cpcp-j695'
+  )
+  expect(expected.length).toEqual(lodashChange.vulnerabilities.length - 1)
+  expect(lodash.vulnerabilities).toEqual(expected)
+})

__tests__/fixtures/config-allow-sample.yml

@@ -0,0 +1,4 @@
+fail_on_severity: critical
+allow_licenses:
+  - "BSD"
+  - "GPL 2"

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

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

__tests__/fixtures/conflictive-config.yml

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

__tests__/fixtures/create-test-change.ts

@@ -0,0 +1,36 @@
+import {Change} from '../../src/schemas'
+import {createTestVulnerability} from './create-test-vulnerability'
+
+const defaultChange: Change = {
+  change_type: 'added',
+  manifest: 'package.json',
+  ecosystem: 'npm',
+  name: 'lodash',
+  version: '4.17.20',
+  package_url: 'pkg:npm/lodash@4.17.20',
+  license: 'MIT',
+  source_repository_url: 'https://github.com/lodash/lodash',
+  scope: 'runtime',
+  vulnerabilities: [
+    createTestVulnerability({
+      severity: 'high',
+      advisory_ghsa_id: 'GHSA-35jh-r3h4-6jhm',
+      advisory_summary: 'Command Injection in lodash',
+      advisory_url: 'https://github.com/advisories/GHSA-35jh-r3h4-6jhm'
+    }),
+    createTestVulnerability({
+      severity: 'moderate',
+      advisory_ghsa_id: 'GHSA-29mw-wpgm-hmr9',
+      advisory_summary:
+        'Regular Expression Denial of Service (ReDoS) in lodash',
+      advisory_url: 'https://github.com/advisories/GHSA-29mw-wpgm-hmr9'
+    })
+  ]
+}
+
+const createTestChange = (overwrites: Partial<Change> = {}): Change => ({
+  ...defaultChange,
+  ...overwrites
+})
+
+export {createTestChange}

__tests__/fixtures/create-test-vulnerability.ts

@@ -0,0 +1,19 @@
+import {Change} from '../../src/schemas'
+
+type Vulnerability = Change['vulnerabilities'][0]
+
+const defaultTestVulnerability: Vulnerability = {
+  severity: 'high',
+  advisory_ghsa_id: 'GHSA-35jh-r3h4-6jhm',
+  advisory_summary: 'Command Injection in lodash',
+  advisory_url: 'https://github.com/advisories/GHSA-35jh-r3h4-6jhm'
+}
+
+const createTestVulnerability = (
+  overwrites: Partial<Vulnerability> = {}
+): Vulnerability => ({
+  ...defaultTestVulnerability,
+  ...overwrites
+})
+
+export {createTestVulnerability}

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

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

__tests__/fixtures/invalid-severity-config.yml

@@ -0,0 +1,3 @@
+fail_on_severity: 'so many zombies'
+deny_licenses:
+  - MIT

__tests__/fixtures/license-config-sample.yml

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

__tests__/fixtures/no-licenses-config.yml

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

__tests__/licenses.test.ts

@@ -0,0 +1,267 @@
+import {expect, jest, test} from '@jest/globals'
+import {Change, Changes} from '../src/schemas'
+
+let getInvalidLicenseChanges: Function
+
+const 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'
+    }
+  ]
+}
+
+const 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'
+    }
+  ]
+}
+
+const pipChange: Change = {
+  change_type: 'added',
+  manifest: 'requirements.txt',
+  ecosystem: 'pip',
+  name: 'package-1',
+  version: '1.1.1',
+  package_url: 'pkg:pypi/package-1@1.1.1',
+  license: 'MIT',
+  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'
+    }
+  ]
+}
+
+jest.mock('@actions/core')
+
+const mockOctokit = {
+  rest: {
+    licenses: {
+      getForRepo: jest
+        .fn()
+        .mockReturnValue({data: {license: {spdx_id: 'AGPL'}}})
+    }
+  }
+}
+
+jest.mock('octokit', () => {
+  return {
+    // eslint-disable-next-line @typescript-eslint/no-extraneous-class
+    Octokit: class {
+      constructor() {
+        return mockOctokit
+      }
+    }
+  }
+})
+
+beforeEach(async () => {
+  jest.resetModules()
+  jest.doMock('spdx-satisfies', () => {
+    // mock spdx-satisfies return value
+    // true for BSD, false for all others
+    return jest.fn((license: string, _: string): boolean => license === 'BSD')
+  })
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
+  ;({getInvalidLicenseChanges} = require('../src/licenses'))
+})
+
+test('it adds license outside the allow list to forbidden changes', async () => {
+  const changes: Changes = [npmChange, rubyChange]
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
+    allow: ['BSD']
+  })
+  expect(forbidden[0]).toBe(npmChange)
+  expect(forbidden.length).toEqual(1)
+})
+
+test('it adds license inside the deny list to forbidden changes', async () => {
+  const changes: Changes = [npmChange, rubyChange]
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
+    deny: ['BSD']
+  })
+  expect(forbidden[0]).toBe(rubyChange)
+  expect(forbidden.length).toEqual(1)
+})
+
+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'},
+    {...rubyChange, change_type: 'removed'}
+  ]
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
+    allow: ['BSD']
+  })
+  expect(forbidden).toStrictEqual([])
+})
+
+test('it does not add license inside the deny list to forbidden changes if it is in removed changes', async () => {
+  const changes: Changes = [
+    {...npmChange, change_type: 'removed'},
+    {...rubyChange, change_type: 'removed'}
+  ]
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
+    deny: ['BSD']
+  })
+  expect(forbidden).toStrictEqual([])
+})
+
+test('it adds license outside the allow list to forbidden changes if it is in both added and removed changes', async () => {
+  const changes: Changes = [
+    {...npmChange, change_type: 'removed'},
+    npmChange,
+    {...rubyChange, change_type: 'removed'}
+  ]
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
+    allow: ['BSD']
+  })
+  expect(forbidden).toStrictEqual([npmChange])
+})
+
+test('it adds all licenses to unresolved if it is unable to determine the validity', async () => {
+  jest.resetModules() // reset module set in before
+  jest.doMock('spdx-satisfies', () => {
+    return jest.fn((_first: string, _second: string) => {
+      throw new Error('Some Error')
+    })
+  })
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
+  ;({getInvalidLicenseChanges} = require('../src/licenses'))
+  const changes: Changes = [npmChange, rubyChange]
+  const invalidLicenses = await getInvalidLicenseChanges(changes, {
+    allow: ['BSD']
+  })
+  expect(invalidLicenses.forbidden.length).toEqual(0)
+  expect(invalidLicenses.unlicensed.length).toEqual(0)
+  expect(invalidLicenses.unresolved.length).toEqual(2)
+})
+
+test('it does not filter out changes that are on the exclusions list', async () => {
+  const changes: Changes = [pipChange, npmChange, rubyChange]
+  const licensesConfig = {
+    allow: ['BSD'],
+    licenseExclusions: ['pkg:pypi/package-1@1.1.1', 'pkg:npm/reeuhq@1.0.2']
+  }
+  const invalidLicenses = await getInvalidLicenseChanges(
+    changes,
+    licensesConfig
+  )
+  expect(invalidLicenses.forbidden.length).toEqual(0)
+})
+
+test('it does not fail when the packages dont have a valid PURL', async () => {
+  const emptyPurlChange = pipChange
+  emptyPurlChange.package_url = ''
+
+  const changes: Changes = [emptyPurlChange, npmChange, rubyChange]
+  const licensesConfig = {
+    allow: ['BSD'],
+    licenseExclusions: ['pkg:pypi/package-1@1.1.1', 'pkg:npm/reeuhq@1.0.2']
+  }
+
+  const invalidLicenses = await getInvalidLicenseChanges(
+    changes,
+    licensesConfig
+  )
+  expect(invalidLicenses.forbidden.length).toEqual(1)
+})
+
+test('it does filters out changes if they are not on the exclusions list', async () => {
+  const changes: Changes = [pipChange, npmChange, rubyChange]
+  const licensesConfig = {
+    allow: ['BSD'],
+    licenseExclusions: [
+      'pkg:pypi/notmypackage-1@1.1.1',
+      'pkg:npm/alsonot@1.0.2'
+    ]
+  }
+  const invalidLicenses = await getInvalidLicenseChanges(
+    changes,
+    licensesConfig
+  )
+  expect(invalidLicenses.forbidden.length).toEqual(2)
+  expect(invalidLicenses.forbidden[0]).toBe(pipChange)
+  expect(invalidLicenses.forbidden[1]).toBe(npmChange)
+})
+
+describe('GH License API fallback', () => {
+  test('it calls licenses endpoint if atleast one of the changes has null license and valid source_repository_url', async () => {
+    const nullLicenseChange = {
+      ...npmChange,
+      license: null,
+      source_repository_url: 'http://github.com/some-owner/some-repo'
+    }
+    const {unlicensed} = await getInvalidLicenseChanges(
+      [nullLicenseChange, rubyChange],
+      {}
+    )
+
+    expect(mockOctokit.rest.licenses.getForRepo).toHaveBeenNthCalledWith(1, {
+      owner: 'some-owner',
+      repo: 'some-repo'
+    })
+    expect(unlicensed.length).toEqual(0)
+  })
+
+  test('it does not call licenses API endpoint for change with null license and invalid source_repository_url ', async () => {
+    const {unlicensed} = await getInvalidLicenseChanges(
+      [{...npmChange, license: null}],
+      {}
+    )
+    expect(mockOctokit.rest.licenses.getForRepo).not.toHaveBeenCalled()
+    expect(unlicensed.length).toEqual(1)
+  })
+
+  test('it does not call licenses API endpoint if licenses for all changes are present', async () => {
+    const {unlicensed} = await getInvalidLicenseChanges(
+      [npmChange, rubyChange],
+      {}
+    )
+
+    expect(mockOctokit.rest.licenses.getForRepo).not.toHaveBeenCalled()
+    expect(unlicensed.length).toEqual(0)
+  })
+})

__tests__/main.test.ts

@@ -1,5 +0,0 @@
-import {expect, test} from '@jest/globals'
-
-test('tests things', async () => {
-  expect(true).toEqual(true)
-})

__tests__/scorecard.test.ts

@@ -0,0 +1,40 @@
+import {expect, test} from '@jest/globals'
+import {Change, Changes} from '../src/schemas'
+import {getScorecardLevels, getProjectUrl} from '../src/scorecard'
+
+const npmChange: Change = {
+  manifest: 'package.json',
+  change_type: 'added',
+  ecosystem: 'npm',
+  name: 'type-is',
+  version: '1.6.18',
+  package_url: 'pkg:npm/type-is@1.6.18',
+  license: 'MIT',
+  source_repository_url: 'github.com/jshttp/type-is',
+  scope: 'runtime',
+  vulnerabilities: [
+    {
+      severity: 'critical',
+      advisory_ghsa_id: 'first-random_string',
+      advisory_summary: 'very dangerous',
+      advisory_url: 'github.com/future-funk'
+    }
+  ]
+}
+
+test('Get scorecard from API', async () => {
+  const changes: Changes = [npmChange]
+  const scorecard = await getScorecardLevels(changes)
+  expect(scorecard).not.toBeNull()
+  expect(scorecard.dependencies).toHaveLength(1)
+  expect(scorecard.dependencies[0].scorecard?.score).toBeGreaterThan(0)
+})
+
+test('Get project URL from deps.dev API', async () => {
+  const result = await getProjectUrl(
+    npmChange.ecosystem,
+    npmChange.name,
+    npmChange.version
+  )
+  expect(result).not.toBeNull()
+})

__tests__/summary.test.ts

@@ -0,0 +1,424 @@
+import {expect, jest, test} from '@jest/globals'
+import {Changes, ConfigurationOptions, Scorecard} from '../src/schemas'
+import * as summary from '../src/summary'
+import * as core from '@actions/core'
+import {createTestChange} from './fixtures/create-test-change'
+import {createTestVulnerability} from './fixtures/create-test-vulnerability'
+
+afterEach(() => {
+  jest.clearAllMocks()
+  core.summary.emptyBuffer()
+})
+
+const emptyChanges: Changes = []
+const emptyInvalidLicenseChanges = {
+  forbidden: [],
+  unresolved: [],
+  unlicensed: []
+}
+const emptyScorecard: Scorecard = {
+  dependencies: []
+}
+const defaultConfig: ConfigurationOptions = {
+  vulnerability_check: true,
+  license_check: true,
+  fail_on_severity: 'high',
+  fail_on_scopes: ['runtime'],
+  allow_ghsas: [],
+  allow_licenses: [],
+  deny_licenses: [],
+  deny_packages: [],
+  deny_groups: [],
+  comment_summary_in_pr: true,
+  retry_on_snapshot_warnings: false,
+  retry_on_snapshot_warnings_timeout: 120,
+  warn_only: false,
+  warn_on_openssf_scorecard_level: 3,
+  show_openssf_scorecard: false
+}
+
+const changesWithEmptyManifests: Changes = [
+  {
+    change_type: 'added',
+    manifest: '',
+    ecosystem: 'unknown',
+    name: 'castore',
+    version: '0.1.17',
+    package_url: 'pkg:hex/castore@0.1.17',
+    license: null,
+    source_repository_url: null,
+    scope: 'runtime',
+    vulnerabilities: []
+  },
+  {
+    change_type: 'added',
+    manifest: '',
+    ecosystem: 'unknown',
+    name: 'connection',
+    version: '1.1.0',
+    package_url: 'pkg:hex/connection@1.1.0',
+    license: null,
+    source_repository_url: null,
+    scope: 'runtime',
+    vulnerabilities: []
+  },
+  {
+    change_type: 'added',
+    manifest: 'python/dist-info/METADATA',
+    ecosystem: 'pip',
+    name: 'pygments',
+    version: '2.6.1',
+    package_url: 'pkg:pypi/pygments@2.6.1',
+    license: 'BSD-2-Clause',
+    source_repository_url: 'https://github.com/pygments/pygments',
+    scope: 'runtime',
+    vulnerabilities: []
+  }
+]
+
+const scorecard: Scorecard = {
+  dependencies: [
+    {
+      change: {
+        change_type: 'added',
+        manifest: '',
+        ecosystem: 'unknown',
+        name: 'castore',
+        version: '0.1.17',
+        package_url: 'pkg:hex/castore@0.1.17',
+        license: null,
+        source_repository_url: null,
+        scope: 'runtime',
+        vulnerabilities: []
+      },
+      scorecard: null
+    }
+  ]
+}
+
+test('prints headline as h1', () => {
+  summary.addSummaryToSummary(
+    emptyChanges,
+    emptyInvalidLicenseChanges,
+    emptyChanges,
+    scorecard,
+    defaultConfig
+  )
+  const text = core.summary.stringify()
+
+  expect(text).toContain('<h1>Dependency Review</h1>')
+})
+
+test('only includes "No vulnerabilities or license issues found"-message if both are configured and nothing was found', () => {
+  summary.addSummaryToSummary(
+    emptyChanges,
+    emptyInvalidLicenseChanges,
+    emptyChanges,
+    emptyScorecard,
+    defaultConfig
+  )
+  const text = core.summary.stringify()
+
+  expect(text).toContain('✅ No vulnerabilities or license issues found.')
+})
+
+test('only includes "No vulnerabilities found"-message if "license_check" is set to false and nothing was found', () => {
+  const config = {...defaultConfig, license_check: false}
+  summary.addSummaryToSummary(
+    emptyChanges,
+    emptyInvalidLicenseChanges,
+    emptyChanges,
+    emptyScorecard,
+    config
+  )
+  const text = core.summary.stringify()
+
+  expect(text).toContain('✅ No vulnerabilities found.')
+})
+
+test('only includes "No license issues found"-message if "vulnerability_check" is set to false and nothing was found', () => {
+  const config = {...defaultConfig, vulnerability_check: false}
+  summary.addSummaryToSummary(
+    emptyChanges,
+    emptyInvalidLicenseChanges,
+    emptyChanges,
+    emptyScorecard,
+    config
+  )
+  const text = core.summary.stringify()
+
+  expect(text).toContain('✅ No license issues found.')
+})
+
+test('groups dependencies with empty manifest paths together', () => {
+  summary.addSummaryToSummary(
+    changesWithEmptyManifests,
+    emptyInvalidLicenseChanges,
+    emptyChanges,
+    emptyScorecard,
+    defaultConfig
+  )
+  summary.addScannedDependencies(changesWithEmptyManifests)
+  const text = core.summary.stringify()
+
+  expect(text).toContain('<summary>Unnamed Manifest</summary>')
+  expect(text).toContain('castore')
+  expect(text).toContain('connection')
+  expect(text).toContain('<summary>python/dist-info/METADATA</summary>')
+  expect(text).toContain('pygments')
+})
+
+test('does not include status section if nothing was found', () => {
+  summary.addSummaryToSummary(
+    emptyChanges,
+    emptyInvalidLicenseChanges,
+    emptyChanges,
+    emptyScorecard,
+    defaultConfig
+  )
+  const text = core.summary.stringify()
+
+  expect(text).not.toContain('The following issues were found:')
+})
+
+test('includes count and status icons for all findings', () => {
+  const vulnerabilities = [
+    createTestChange({name: 'lodash'}),
+    createTestChange({name: 'underscore', package_url: 'test-url'})
+  ]
+  const licenseIssues = {
+    forbidden: [createTestChange()],
+    unresolved: [createTestChange(), createTestChange()],
+    unlicensed: [createTestChange(), createTestChange(), createTestChange()]
+  }
+
+  summary.addSummaryToSummary(
+    vulnerabilities,
+    licenseIssues,
+    emptyChanges,
+    emptyScorecard,
+    defaultConfig
+  )
+
+  const text = core.summary.stringify()
+  expect(text).toContain('❌ 2 vulnerable package(s)')
+  expect(text).toContain(
+    '❌ 2 package(s) with invalid SPDX license definitions'
+  )
+  expect(text).toContain('❌ 1 package(s) with incompatible licenses')
+  expect(text).toContain('⚠️ 3 package(s) with unknown licenses')
+})
+
+test('uses checkmarks for license issues if only vulnerabilities were found', () => {
+  const vulnerabilities = [createTestChange()]
+
+  summary.addSummaryToSummary(
+    vulnerabilities,
+    emptyInvalidLicenseChanges,
+    emptyChanges,
+    emptyScorecard,
+    defaultConfig
+  )
+
+  const text = core.summary.stringify()
+  expect(text).toContain('❌ 1 vulnerable package(s)')
+  expect(text).toContain(
+    '✅ 0 package(s) with invalid SPDX license definitions'
+  )
+  expect(text).toContain('✅ 0 package(s) with incompatible licenses')
+  expect(text).toContain('✅ 0 package(s) with unknown licenses')
+})
+
+test('uses checkmarks for vulnerabilities if only license issues were found', () => {
+  const licenseIssues = {
+    forbidden: [createTestChange()],
+    unresolved: [],
+    unlicensed: []
+  }
+
+  summary.addSummaryToSummary(
+    emptyChanges,
+    licenseIssues,
+    emptyChanges,
+    emptyScorecard,
+    defaultConfig
+  )
+
+  const text = core.summary.stringify()
+  expect(text).toContain('✅ 0 vulnerable package(s)')
+  expect(text).toContain(
+    '✅ 0 package(s) with invalid SPDX license definitions'
+  )
+  expect(text).toContain('❌ 1 package(s) with incompatible licenses')
+  expect(text).toContain('✅ 0 package(s) with unknown licenses')
+})
+
+test('addChangeVulnerabilitiesToSummary() - only includes section if any vulnerabilites found', () => {
+  summary.addChangeVulnerabilitiesToSummary(emptyChanges, 'low')
+  const text = core.summary.stringify()
+  expect(text).toEqual('')
+})
+
+test('addChangeVulnerabilitiesToSummary() - includes all vulnerabilities', () => {
+  const changes = [
+    createTestChange({name: 'lodash'}),
+    createTestChange({name: 'underscore', package_url: 'test-url'})
+  ]
+
+  summary.addChangeVulnerabilitiesToSummary(changes, 'low')
+
+  const text = core.summary.stringify()
+  expect(text).toContain('<h2>Vulnerabilities</h2>')
+  expect(text).toContain('lodash')
+  expect(text).toContain('underscore')
+})
+
+test('addChangeVulnerabilitiesToSummary() - includes advisory url if available', () => {
+  const changes = [
+    createTestChange({
+      name: 'underscore',
+      vulnerabilities: [
+        createTestVulnerability({
+          advisory_summary: 'test-summary',
+          advisory_url: 'test-url'
+        })
+      ]
+    })
+  ]
+
+  summary.addChangeVulnerabilitiesToSummary(changes, 'low')
+
+  const text = core.summary.stringify()
+  expect(text).toContain('lodash')
+  expect(text).toContain('<a href="test-url">test-summary</a>')
+})
+
+test('addChangeVulnerabilitiesToSummary() - groups vulnerabilities of a single package', () => {
+  const changes = [
+    createTestChange({
+      name: 'package-with-multiple-vulnerabilities',
+      vulnerabilities: [
+        createTestVulnerability({advisory_summary: 'test-summary-1'}),
+        createTestVulnerability({advisory_summary: 'test-summary-2'})
+      ]
+    })
+  ]
+
+  summary.addChangeVulnerabilitiesToSummary(changes, 'low')
+
+  const text = core.summary.stringify()
+  expect(text.match('package-with-multiple-vulnerabilities')).toHaveLength(1)
+  expect(text).toContain('test-summary-1')
+  expect(text).toContain('test-summary-2')
+})
+
+test('addChangeVulnerabilitiesToSummary() - prints severity statement if above low', () => {
+  const changes = [createTestChange()]
+
+  summary.addChangeVulnerabilitiesToSummary(changes, 'medium')
+
+  const text = core.summary.stringify()
+  expect(text).toContain(
+    'Only included vulnerabilities with severity <strong>medium</strong> or higher.'
+  )
+})
+
+test('addChangeVulnerabilitiesToSummary() - does not print severity statment if it is set to "low"', () => {
+  const changes = [createTestChange()]
+
+  summary.addChangeVulnerabilitiesToSummary(changes, 'low')
+
+  const text = core.summary.stringify()
+  expect(text).not.toContain('Only included vulnerabilities')
+})
+
+test('addLicensesToSummary() - does not include entire section if no license issues found', () => {
+  summary.addLicensesToSummary(emptyInvalidLicenseChanges, defaultConfig)
+  const text = core.summary.stringify()
+  expect(text).toEqual('')
+})
+
+test('addLicensesToSummary() - includes all license issues in table', () => {
+  const licenseIssues = {
+    forbidden: [createTestChange()],
+    unresolved: [createTestChange(), createTestChange()],
+    unlicensed: [createTestChange(), createTestChange(), createTestChange()]
+  }
+
+  summary.addLicensesToSummary(licenseIssues, defaultConfig)
+
+  const text = core.summary.stringify()
+  expect(text).toContain('<h2>License Issues</h2>')
+  expect(text).toContain('<td>Incompatible License</td>')
+  expect(text).toContain('<td>Invalid SPDX License</td>')
+  expect(text).toContain('<td>Unknown License</td>')
+})
+
+test('addLicenseToSummary() - adds one table per manifest', () => {
+  const licenseIssues = {
+    forbidden: [
+      createTestChange({manifest: 'package.json'}),
+      createTestChange({manifest: '.github/workflows/test.yml'})
+    ],
+    unresolved: [],
+    unlicensed: []
+  }
+
+  summary.addLicensesToSummary(licenseIssues, defaultConfig)
+
+  const text = core.summary.stringify()
+
+  expect(text).toContain('<h4><em>package.json</em></h4>')
+  expect(text).toContain('<h4><em>.github/workflows/test.yml</em></h4>')
+})
+
+test('addLicensesToSummary() - does not include specific license type sub-section if nothing is found', () => {
+  const licenseIssues = {
+    forbidden: [],
+    unlicensed: [],
+    unresolved: [createTestChange()]
+  }
+
+  summary.addLicensesToSummary(licenseIssues, defaultConfig)
+
+  const text = core.summary.stringify()
+  expect(text).not.toContain('<td>Incompatible License</td>')
+  expect(text).not.toContain('<td>Unknown License</td>')
+  expect(text).toContain('<td>Invalid SPDX License</td>')
+})
+
+test('addLicensesToSummary() - includes list of configured allowed licenses', () => {
+  const licenseIssues = {
+    forbidden: [createTestChange()],
+    unresolved: [],
+    unlicensed: []
+  }
+
+  const config: ConfigurationOptions = {
+    ...defaultConfig,
+    allow_licenses: ['MIT', 'Apache-2.0']
+  }
+
+  summary.addLicensesToSummary(licenseIssues, config)
+
+  const text = core.summary.stringify()
+  expect(text).toContain('<strong>Allowed Licenses</strong>: MIT, Apache-2.0')
+})
+
+test('addLicensesToSummary() - includes configured denied license', () => {
+  const licenseIssues = {
+    forbidden: [createTestChange()],
+    unresolved: [],
+    unlicensed: []
+  }
+
+  const config: ConfigurationOptions = {
+    ...defaultConfig,
+    deny_licenses: ['MIT']
+  }
+
+  summary.addLicensesToSummary(licenseIssues, config)
+
+  const text = core.summary.stringify()
+  expect(text).toContain('<strong>Denied Licenses</strong>: MIT')
+})

__tests__/test-helpers.ts

@@ -0,0 +1,29 @@
+// GitHub Action inputs come in the form of environment variables
+// with an INPUT prefix (e.g. INPUT_FAIL-ON-SEVERITY)
+export function setInput(input: string, value: string): void {
+  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.
+export function clearInputs(): void {
+  const allowedOptions = [
+    'FAIL-ON-SEVERITY',
+    'FAIL-ON-SCOPES',
+    'ALLOW-LICENSES',
+    'DENY-LICENSES',
+    'ALLOW-GHSAS',
+    'LICENSE-CHECK',
+    'VULNERABILITY-CHECK',
+    'CONFIG-FILE',
+    'BASE-REF',
+    'HEAD-REF',
+    'COMMENT-SUMMARY-IN-PR',
+    'WARN-ONLY'
+  ]
+
+  // eslint-disable-next-line github/array-foreach
+  allowedOptions.forEach(option => {
+    delete process.env[`INPUT_${option.toUpperCase()}`]
+  })
+}

action.yml

@@ -1,11 +1,93 @@
+# IMPORTANT
+#
+# Avoid setting default values for configuration options in
+# this file, they will overwrite external configurations.
+#
+# If you are trying to find out the default value for a config
+# option please take a look at the README or src/schemas.ts.
+#
+# If you are adding an option, make sure the Zod definition
+# contains a default value.
 name: 'Dependency Review'
-description: 'GitHub Action for Dependency Review'
+description: 'Prevent the introduction of dependencies with known vulnerabilities'
 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
+  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
+  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 path 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-dependencies-licenses:
+    description: Comma-separated list of dependencies in purl format (e.g. "pkg:npm/express, pkg:pypi/pycrypto"). These dependencies will be permitted to use any license, no matter what license policy is enforced otherwise.
+    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
+  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
+  comment-summary-in-pr:
+    description: Determines if the summary is posted as a comment in the PR itself. Setting this to `always` or `on-failure` requires you to give the workflow the write permissions for pull-requests
+    required: false
+  deny-packages:
+    description: A comma-separated list of package URLs to deny (e.g. "pkg:npm/express, pkg:pypi/pycrypto")
+    required: false
+  deny-groups:
+    description: A comma-separated list of package URLs for group(s)/namespace(s) to deny (e.g. "pkg:npm/express, pkg:pypi/pycrypto")
+    required: false
+  retry-on-snapshot-warnings:
+    description: Whether to retry on snapshot warnings
+    required: false
+  retry-on-snapshot-warnings-timeout:
+    description: Number of seconds to wait before stopping snapshot retries.
+    required: false
+  warn-only:
+    description: When set to `true` this action will always complete with success, overriding the `fail-on-severity` parameter.
+    required: false
+  show-openssf-scorecard:
+    description: Show a summary of the OpenSSF Scorecard scores.
+    required: false
+  warn-on-openssf-scorecard-level:
+    description: Numeric threshold for the OpenSSF Scorecard score. If the score is below this threshold, the action will warn you.
+    required: false
+outputs:
+  comment-content:
+    description: Prepared dependency report comment
+  dependency-changes:
+    description: All dependency changes (JSON)
+  vulnerable-changes:
+    description: Vulnerable dependency changes (JSON)
+  invalid-license-changes:
+    description: Invalid license dependency changes (JSON)
+  denied-changes:
+    description: Denied dependency changes (JSON)
+
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'

docs/examples.md

@@ -0,0 +1,339 @@
+# Examples on how to use the Dependency Review Action
+
+## Basic Usage
+
+A very basic example of how to use the action. This will run the action with the default configuration.
+
+The full list of configuration options can be found [here](../README.md#configuration-options).
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+```
+
+## Using an inline configuration
+
+The following example will fail the action if any vulnerabilities are found with a severity of medium or higher; and if any packages are found with an incompatible license - in this case, the LGPL-2.0 and BSD-2-Clause licenses.
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        with:
+          fail-on-severity: critical
+          deny-licenses: LGPL-2.0, BSD-2-Clause
+```
+
+## Using a configuration file
+
+The following example will use a configuration file to configure the action. This is useful if you want to keep your configuration in a single place and makes it easier to manage as the configuration grows.
+
+The configuration file can be located in the same repository or in a separate repository. Having it in a separate repository might be useful if you plan to use the same configuration across multiple repositories and control it centrally.
+
+In this example, the configuration file is located in the same repository under `.github/dependency-review-config.yml`. The following configuration will fail the action if any vulnerabilities are found with a severity of critical; and if any packages are found with an incompatible license - in this case, the LGPL-2.0 and BSD-2-Clause licenses.
+
+```yaml
+fail_on_severity: 'critical'
+allow_licenses:
+  - 'LGPL-2.0'
+  - 'BSD-2-Clause'
+```
+
+The Dependency Review Action workflow file will then look like this:
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        with:
+          config-file: './.github/dependency-review-config.yml'
+```
+
+## Using a configuration file from an external repository
+
+The following example will use a configuration file from an external public GitHub repository to configure the action.
+
+Let's say that the configuration file is located in `github/octorepo/dependency-review-config.yml@main`
+
+The Dependancy Review Action workflow file will then look like this:
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        with:
+          config-file: 'github/octorepo/dependency-review-config.yml@main'
+```
+
+## Using a configuration file from an external repository with a personal access token
+
+The following example will use a configuration file from an external private GtiHub repository to configure the action.
+
+Let's say that the configuration file is located in `github/octorepo-private/dependency-review-config.yml@main`
+
+The Dependancy Review Action workflow file will then look like this:
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        with:
+          config-file: 'github/octorepo-private/dependency-review-config.yml@main'
+          external-repo-token: ${{ secrets.GITHUB_TOKEN }} # or a personal access token
+```
+
+## Getting the results of the action in the PR as a comment
+
+Using the `comment-summary-in-pr` you can get the results of the action in the PR as a comment. In order for this to work, the action needs to be able to create a comment in the PR. This requires additional `pull-requests: write` permission.
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        with:
+          fail-on-severity: critical
+          deny-licenses: LGPL-2.0, BSD-2-Clause
+          comment-summary-in-pr: always
+```
+
+## Getting the results of the action in a later step
+
+- `comment-content` contains the output of the results comment for the entire run.
+`dependency-changes`, `vulnerable-changes`, `invalid-license-changes` and `denied-changes` are all JSON objects that allow you to access individual sets of changes.
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        id: review
+        uses: actions/dependency-review-action@v4
+        with:
+          fail-on-severity: critical
+          deny-licenses: LGPL-2.0, BSD-2-Clause
+      - name: 'Report'
+        # make sure this step runs even if the previous failed
+        if: ${{ failure() && steps.review.conclusion == 'failure' }}
+        shell: bash
+        env: # store comment HTML data in an environment variable
+          COMMENT: ${{ steps.review.outputs.comment-content }}
+        run: | # do something with the comment:
+          echo "$COMMENT"
+      - name: 'List vulnerable dependencies'
+        # make sure this step runs even if the previous failed
+        if: ${{ failure() && steps.review.conclusion == 'failure' }}
+        shell: bash
+        env: # store JSON data in an environment variable
+          VULNERABLE_CHANGES: ${{ steps.review.outputs.vulnerable-changes }}
+        run: | # do something with the JSON:
+          echo "$VULNERABLE_CHANGES" | jq '.[].package_url'
+```
+
+## Exclude dependencies from the license check
+
+Using the `allow-dependencies-licenses` you can exclude dependencies from the license check. The values should be provided in [purl](https://github.com/package-url/purl-spec) format.
+
+In this example, we are excluding `lodash` from `npm` and `requests` from `pip` dependencies from the license check
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        with:
+          fail-on-severity: critical
+          deny-licenses: LGPL-2.0, BSD-2-Clause
+          comment-summary-in-pr: always
+          allow-dependencies-licenses: 'pkg:npm/loadash, pkg:pypi/requests'
+```
+
+If we were to use configuration file, the configuration would look like this:
+
+```yaml
+fail-on-severity: 'critical'
+allow-licenses:
+  - 'LGPL-2.0'
+  - 'BSD-2-Clause'
+allow-dependencies-licenses:
+  - 'pkg:npm/loadash'
+  - 'pkg:pypi/requests'
+```
+
+## Only check for vulnerabilities
+
+To only do the vulnerability check you can use the `license-check` to disable the license compatibility check (which is done by default).
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        with:
+          fail-on-severity: critical
+          comment-summary-in-pr: always
+          license-check: false
+```
+
+## Exclude dependencies from their name or groups
+
+Using the `deny-packages` option you can exclude dependencies by their PURL. You can add multiple values separated by a commas.
+Using the `deny-groups` option you can exclude dependencies by their group name/namespace. You can add multiple values separated by a comma.
+
+In this example, we are excluding `pkg:maven/org.apache.logging.log4j:log4j-api` and `pkg:maven/org.apache.logging.log4j/log4j-core` from `maven` and all packages in the group `pkg:maven/com.bazaarvoice.maven`
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        with:
+          deny-packages: 'pkg:maven/org.apache.logging.log4j/log4j-api,pkg:maven/org.apache.logging.log4j/log4j-core'
+          deny-groups: 'pkg:maven/com.bazaarvoice.jolt'
+```
+
+## Waiting for dependency submission jobs to complete
+
+When possible, this action will [include dependencies submitted through the dependency submission API][DSAPI]. In this case,
+it's important for the action not to complete until all of the relevant dependencies have been submitted for both the base
+and head commits.
+
+When this action runs before one or more of the dependency submission actions, there will be an unequal number of dependency
+snapshots between the base and head commits. For example, there may be one snapshot available for the tip of `main` and none
+for the PR branch. In that case, the API response will contain a "snapshot warning" explaining the discrepancy.
+
+In this example, when the action encounters one of these warnings it will retry every 10 seconds after that for 60 seconds
+or until there is no warning in the response.
+
+```yaml
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        with:
+          retry-on-snapshot-warnings: true
+          retry-on-snapshot-warnings-timeout: 60
+```
+
+[DSAPI]: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#best-practices-for-using-the-dependency-review-api-and-the-dependency-submission-api-together

jest.config.js

@@ -1,9 +1,9 @@
 module.exports = {
   clearMocks: true,
-  moduleFileExtensions: ['js', 'ts'],
+  moduleFileExtensions: ['js', 'json', 'ts'],
   testMatch: ['**/*.test.ts'],
   transform: {
     '^.+\\.ts$': 'ts-jest'
   },
   verbose: true
-}
+}

package.json

@@ -1,11 +1,11 @@
 {
   "name": "dependency-review-action",
-  "version": "0.0.1",
+  "version": "4.2.3",
   "private": true,
   "description": "A GitHub Action for Dependency Review",
   "main": "lib/main.js",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -p tsconfig.build.json",
     "format": "prettier --write '**/*.ts'",
     "format-check": "prettier --check '**/*.ts'",
     "lint": "eslint src/**/*.ts",
@@ -25,29 +25,37 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.6.0",
-    "@actions/github": "^5.0.0",
-    "@octokit/plugin-retry": "^3.0.9",
-    "@octokit/request-error": "^2.1.0",
-    "ansi-styles": "^6.1.0",
-    "got": "^12.0.1",
-    "nodemon": "^2.0.15",
-    "zod": "^3.13.4"
+    "@actions/core": "^1.10.1",
+    "@actions/github": "^6.0.0",
+    "@octokit/plugin-retry": "^6.0.1",
+    "@octokit/request-error": "^5.0.1",
+    "@types/jest": "^29.5.12",
+    "ansi-styles": "^6.2.1",
+    "got": "^14.2.0",
+    "jest": "^29.7.0",
+    "octokit": "^3.1.2",
+    "packageurl-js": "^1.2.0",
+    "spdx-expression-parse": "^3.0.1",
+    "spdx-satisfies": "^5.0.1",
+    "ts-jest": "^29.1.2",
+    "yaml": "^2.3.4",
+    "zod": "^3.22.3"
   },
   "devDependencies": {
-    "@types/node": "^17.0.23",
-    "@typescript-eslint/eslint-plugin": "^5.14.0",
-    "@typescript-eslint/parser": "^5.14.0",
-    "@vercel/ncc": "^0.33.3",
-    "esbuild-register": "^3.3.2",
-    "eslint": "^8.12.0",
-    "eslint-plugin-github": "^4.3.6",
-    "eslint-plugin-jest": "^26.1.1",
-    "jest": "^27.5.1",
+    "@types/node": "^20",
+    "@types/spdx-expression-parse": "^3.0.4",
+    "@types/spdx-satisfies": "^0.1.1",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "@vercel/ncc": "^0.38.0",
+    "esbuild-register": "^3.5.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-github": "^4.10.1",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-prettier": "^5.1.3",
     "js-yaml": "^4.1.0",
-    "nodemon": "^2.0.15",
-    "prettier": "2.6.1",
-    "ts-jest": "^27.1.3",
-    "typescript": "^4.6.3"
+    "nodemon": "^3.1.0",
+    "prettier": "3.2.5",
+    "typescript": "^5.3.3"
   }
 }

scripts/create_summary.ts

@@ -0,0 +1,155 @@
+/**
+ * This scripts creates example markdown files for the summary in the ./tmp folder.
+ * You can use it to preview changes to the summary.
+ *
+ * You can execute it like this:
+ * npx ts-node scripts/create_summary.ts
+ */
+
+import {Change, Changes, ConfigurationOptions, Scorecard} from '../src/schemas'
+import {createTestChange} from '../__tests__/fixtures/create-test-change'
+import {InvalidLicenseChanges} from '../src/licenses'
+import * as fs from 'fs'
+import * as core from '@actions/core'
+import * as summary from '../src/summary'
+import * as path from 'path'
+
+const defaultConfig: ConfigurationOptions = {
+  vulnerability_check: true,
+  license_check: true,
+  fail_on_severity: 'high',
+  fail_on_scopes: ['runtime'],
+  allow_ghsas: [],
+  allow_licenses: ['MIT'],
+  deny_licenses: [],
+  deny_packages: [],
+  deny_groups: [],
+  allow_dependencies_licenses: [
+    'pkg:npm/express@4.17.1',
+    'pkg:pypi/requests',
+    'pkg:pypi/certifi',
+    'pkg:pypi/pycrypto@2.6.1'
+  ],
+  comment_summary_in_pr: true,
+  retry_on_snapshot_warnings: false,
+  retry_on_snapshot_warnings_timeout: 120,
+  warn_only: false,
+  warn_on_openssf_scorecard_level: 3,
+  show_openssf_scorecard: true
+}
+
+const scorecard: Scorecard = {
+  dependencies: [
+    {
+      change: {
+        change_type: 'added',
+        manifest: '',
+        ecosystem: 'unknown',
+        name: 'castore',
+        version: '0.1.17',
+        package_url: 'pkg:hex/castore@0.1.17',
+        license: null,
+        source_repository_url: null,
+        scope: 'runtime',
+        vulnerabilities: []
+      },
+      scorecard: null
+    }
+  ]
+}
+
+const tmpDir = path.resolve(__dirname, '../tmp')
+
+const createExampleSummaries = async (): Promise<void> => {
+  await fs.promises.mkdir(tmpDir, {recursive: true})
+
+  await createNonIssueSummary()
+  await createFullSummary()
+}
+
+const createNonIssueSummary = async (): Promise<void> => {
+  await createSummary(
+    [],
+    {forbidden: [], unresolved: [], unlicensed: []},
+    [],
+    defaultConfig,
+    'non-issue-summary.md'
+  )
+}
+
+const createFullSummary = async (): Promise<void> => {
+  const changes = [createTestChange()]
+  const licenses: InvalidLicenseChanges = {
+    forbidden: [
+      createTestChange({
+        name: 'underscore',
+        version: '1.12.0',
+        license: 'Apache 2.0'
+      })
+    ],
+    unresolved: [
+      createTestChange({
+        name: 'octoinvader',
+        license: 'Non SPDX License'
+      }),
+      createTestChange({
+        name: 'owner/action-1',
+        license: 'XYZ-License',
+        version: 'v1.2.2',
+        manifest: '.github/workflows/action.yml'
+      })
+    ],
+    unlicensed: [
+      createTestChange({
+        name: 'my-other-dependency',
+        license: null
+      }),
+      createTestChange({
+        name: 'owner/action-2',
+        version: 'main',
+        license: null,
+        manifest: '.github/workflows/action.yml'
+      })
+    ]
+  }
+
+  await createSummary(changes, licenses, [], defaultConfig, 'full-summary.md')
+}
+
+async function createSummary(
+  vulnerabilities: Changes,
+  licenseIssues: InvalidLicenseChanges,
+  denied: Change[],
+  config: ConfigurationOptions,
+  fileName: string
+): Promise<void> {
+  summary.addSummaryToSummary(
+    vulnerabilities,
+    licenseIssues,
+    denied,
+    scorecard,
+    config
+  )
+  summary.addChangeVulnerabilitiesToSummary(
+    vulnerabilities,
+    config.fail_on_severity
+  )
+  summary.addLicensesToSummary(licenseIssues, defaultConfig)
+
+  const allChanges = [
+    ...vulnerabilities,
+    ...licenseIssues.forbidden,
+    ...licenseIssues.unresolved,
+    ...licenseIssues.unlicensed
+  ]
+
+  summary.addScannedDependencies(allChanges)
+
+  const text = core.summary.stringify()
+  await fs.promises.writeFile(path.resolve(tmpDir, fileName), text, {
+    flag: 'w'
+  })
+  core.summary.emptyBuffer()
+}
+
+createExampleSummaries()

scripts/scan_pr

@@ -3,22 +3,52 @@ require 'json'
 require 'tempfile'
 require 'open3'
 require 'bundler/inline'
+require 'optparse'
 
 gemfile do
   source 'https://rubygems.org'
   gem 'octokit'
 end
 
+config_file = nil
 github_token = ENV["GITHUB_TOKEN"]
+
 if !github_token || github_token.empty?
   puts "Please set the GITHUB_TOKEN environment variable"
   exit -1
 end
 
-arg = /(?<repo_nwo>[\w\-]+\/[\w\-]+)\/pull\/(?<pr_number>\d+)/.match(ARGV[0])
+op = OptionParser.new do |opts|
+  usage = <<EOF
+Run Dependency Review on a repository.
+
+\e[1mUsage:\e[22m
+  scripts/scan_pr [options] <pr_url>
+
+\e[1mExample:\e[22m
+  scripts/scan_pr https://github.com/actions/dependency-review-action/pull/294
+
+EOF
+
+  opts.banner = usage
+
+  opts.on('-c', '--config-file <FILE>', 'Use an external configuration file') do |cf|
+    config_file = cf
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+op.parse!
+
+# make sure we have a NWO somewhere in the parameters
+arg = /(?<repo_nwo>[\w\-]+\/[\w\-]+)\/pull\/(?<pr_number>\d+)/.match(ARGV.join(" "))
 
 if arg.nil?
-  puts "Usage: script/scan_pr <pr_url>"
+  puts op
   exit -1
 end
 
@@ -32,17 +62,26 @@ event_file = Tempfile.new
 event_file.write("{ \"pull_request\": #{pr.to_h.to_json}}")
 event_file.close
 
-dev_cmd_env = {
-  "INPUT_REPO-TOKEN" => github_token,
-  "GITHUB_REPOSITORY" => repo_nwo,
-  "GITHUB_EVENT_NAME" => "pull_request",
-  "GITHUB_EVENT_PATH" => event_file.path
+action_inputs = {
+  "repo-token": github_token,
+  "config-file": config_file
 }
 
-dev_cmd = "./node_modules/.bin/nodemon --exec \"node -r esbuild-register\" src/main.ts"
+dev_cmd_env = {
+  "GITHUB_REPOSITORY" => repo_nwo,
+  "GITHUB_EVENT_NAME" => "pull_request",
+  "GITHUB_EVENT_PATH" => event_file.path,
+  "GITHUB_STEP_SUMMARY" => "/dev/null"
+}
+
+# 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"
 
 Open3.popen2e(dev_cmd_env, dev_cmd) do |stdin, out|
   while line = out.gets
-    puts line
+    puts line.gsub(github_token, "<REDACTED>")
   end
 end

src/comment-pr.ts

@@ -0,0 +1,102 @@
+import * as github from '@actions/github'
+import * as core from '@actions/core'
+import * as githubUtils from '@actions/github/lib/utils'
+import * as retry from '@octokit/plugin-retry'
+import {RequestError} from '@octokit/request-error'
+import {ConfigurationOptions} from './schemas'
+
+const retryingOctokit = githubUtils.GitHub.plugin(retry.retry)
+const octo = new retryingOctokit(
+  githubUtils.getOctokitOptions(core.getInput('repo-token', {required: true}))
+)
+
+// Comment Marker to identify an existing comment to update, so we don't spam the PR with comments
+const COMMENT_MARKER = '<!-- dependency-review-pr-comment-marker -->'
+
+export async function commentPr(
+  summary: typeof core.summary,
+  config: ConfigurationOptions
+): Promise<void> {
+  const commentContent = summary.stringify()
+
+  core.setOutput('comment-content', commentContent)
+
+  if (
+    !(
+      config.comment_summary_in_pr === 'always' ||
+      (config.comment_summary_in_pr === 'on-failure' &&
+        process.exitCode === core.ExitCode.Failure)
+    )
+  ) {
+    return
+  }
+
+  if (!github.context.payload.pull_request) {
+    core.warning(
+      'Not in the context of a pull request. Skipping comment creation.'
+    )
+    return
+  }
+
+  const commentBody = `${commentContent}\n\n${COMMENT_MARKER}`
+
+  try {
+    const existingCommentId = await findCommentByMarker(COMMENT_MARKER)
+
+    if (existingCommentId) {
+      await octo.rest.issues.updateComment({
+        owner: github.context.repo.owner,
+        repo: github.context.repo.repo,
+        comment_id: existingCommentId,
+        body: commentBody
+      })
+    } else {
+      await octo.rest.issues.createComment({
+        owner: github.context.repo.owner,
+        repo: github.context.repo.repo,
+        issue_number: github.context.payload.pull_request.number,
+        body: commentBody
+      })
+    }
+  } catch (error) {
+    if (error instanceof RequestError && error.status === 403) {
+      core.warning(
+        `Unable to write summary to pull-request. Make sure you are giving this workflow the permission 'pull-requests: write'.`
+      )
+    } else {
+      if (error instanceof Error) {
+        core.warning(
+          `Unable to comment summary to pull-request, received error: ${error.message}`
+        )
+      } else {
+        core.warning(
+          'Unable to comment summary to pull-request: Unexpected fatal error'
+        )
+      }
+    }
+  }
+}
+
+async function findCommentByMarker(
+  commentBodyIncludes: string
+): Promise<number | undefined> {
+  const commentsIterator = octo.paginate.iterator(
+    octo.rest.issues.listComments,
+    {
+      owner: github.context.repo.owner,
+      repo: github.context.repo.repo,
+      // We are already checking if we are in the context of a pull request in the caller
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      issue_number: github.context.payload.pull_request!.number
+    }
+  )
+
+  for await (const {data: comments} of commentsIterator) {
+    const existingComment = comments.find(comment =>
+      comment.body?.includes(commentBodyIncludes)
+    )
+    if (existingComment) return existingComment.id
+  }
+
+  return undefined
+}

src/config.ts

@@ -0,0 +1,245 @@
+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} from './schemas'
+import {isSPDXValid, octokitClient} from './utils'
+import {PackageURL} from 'packageurl-js'
+
+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_dependencies_licenses = parseList(
+    getOptionalInput('allow-dependencies-licenses')
+  )
+  const deny_packages = parseList(getOptionalInput('deny-packages'))
+  const deny_groups = parseList(getOptionalInput('deny-groups'))
+  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')
+  const comment_summary_in_pr = getOptionalInput('comment-summary-in-pr')
+  const retry_on_snapshot_warnings = getOptionalBoolean(
+    'retry-on-snapshot-warnings'
+  )
+  const retry_on_snapshot_warnings_timeout = getOptionalNumber(
+    'retry-on-snapshot-warnings-timeout'
+  )
+  const warn_only = getOptionalBoolean('warn-only')
+  const show_openssf_scorecard = getOptionalBoolean('show-openssf-scorecard')
+  const warn_on_openssf_scorecard_level = getOptionalNumber(
+    'warn-on-openssf-scorecard-level'
+  )
+
+  validatePURL(allow_dependencies_licenses)
+  validateLicenses('allow-licenses', allow_licenses)
+  validateLicenses('deny-licenses', deny_licenses)
+
+  const keys = {
+    fail_on_severity,
+    fail_on_scopes,
+    allow_licenses,
+    deny_licenses,
+    deny_packages,
+    deny_groups,
+    allow_dependencies_licenses,
+    allow_ghsas,
+    license_check,
+    vulnerability_check,
+    base_ref,
+    head_ref,
+    comment_summary_in_pr,
+    retry_on_snapshot_warnings,
+    retry_on_snapshot_warnings_timeout,
+    warn_only,
+    show_openssf_scorecard,
+    warn_on_openssf_scorecard_level
+  }
+
+  return Object.fromEntries(
+    Object.entries(keys).filter(([_, value]) => value !== undefined)
+  )
+}
+
+function getOptionalNumber(name: string): number | undefined {
+  const value = core.getInput(name)
+  const parsed = z.string().regex(/^\d+$/).transform(Number).safeParse(value)
+  return parsed.success ? parsed.data : undefined
+}
+
+function getOptionalBoolean(name: string): boolean | undefined {
+  const value = core.getInput(name)
+  return value.length > 0 ? core.getBooleanInput(name) : undefined
+}
+
+function getOptionalInput(name: string): string | undefined {
+  const value = core.getInput(name)
+  return value.length > 0 ? value : undefined
+}
+
+function parseList(list: string | undefined): string[] | undefined {
+  if (list === undefined) {
+    return list
+  } else {
+    return list.split(',').map(x => x.trim())
+  }
+}
+
+function validateLicenses(
+  key: 'allow-licenses' | 'deny-licenses',
+  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}`
+    )
+  }
+}
+
+function parseConfigFile(configData: string): ConfigurationOptionsPartial {
+  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',
+      'allow-dependencies-licenses',
+      'deny-packages',
+      'deny-groups'
+    ]
+
+    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])
+      }
+
+      // validate purls from the allow-dependencies-licenses
+      if (key === 'allow-dependencies-licenses') {
+        validatePURL(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) {
+    throw error
+  }
+}
+
+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')
+  }
+}
+function validatePURL(allow_dependencies_licenses: string[] | undefined): void {
+  //validate that the provided elements of the string are in valid purl format
+  if (allow_dependencies_licenses === undefined) {
+    return
+  }
+  const invalid_purls = allow_dependencies_licenses.filter(
+    purl => !PackageURL.fromString(purl)
+  )
+
+  if (invalid_purls.length > 0) {
+    throw new Error(
+      `Invalid purl(s) in allow-dependencies-licenses: ${invalid_purls}`
+    )
+  }
+  return
+}

src/deny.ts

@@ -0,0 +1,42 @@
+import {Change} from './schemas'
+import * as core from '@actions/core'
+
+export async function getDeniedChanges(
+  changes: Change[],
+  deniedPackages: string[],
+  deniedGroups: string[]
+): Promise<Change[]> {
+  const changesDenied: Change[] = []
+
+  let failed = false
+  for (const change of changes) {
+    change.name = change.name.toLowerCase()
+    const packageUrl = change.package_url.toLowerCase().split('@')[0]
+
+    if (deniedPackages) {
+      for (const denied of deniedPackages) {
+        if (packageUrl === denied.split('@')[0].toLowerCase()) {
+          changesDenied.push(change)
+          failed = true
+        }
+      }
+    }
+
+    if (deniedGroups) {
+      for (const denied of deniedGroups) {
+        if (packageUrl.startsWith(denied.toLowerCase())) {
+          changesDenied.push(change)
+          failed = true
+        }
+      }
+    }
+  }
+
+  if (failed) {
+    core.setFailed('Dependency review detected denied packages.')
+  } else {
+    core.info('Dependency review did not detect any denied packages')
+  }
+
+  return changesDenied
+}

src/dependency-graph.ts

@@ -1,9 +1,14 @@
 import * as core from '@actions/core'
 import * as githubUtils from '@actions/github/lib/utils'
 import * as retry from '@octokit/plugin-retry'
-import {Changes, ChangesSchema} from './schemas'
+import {
+  ChangesSchema,
+  ComparisonResponse,
+  ComparisonResponseSchema
+} from './schemas'
 
 const retryingOctokit = githubUtils.GitHub.plugin(retry.retry)
+const SnapshotWarningsHeader = 'x-github-dependency-graph-snapshot-warnings'
 const octo = new retryingOctokit(
   githubUtils.getOctokitOptions(core.getInput('repo-token', {required: true}))
 )
@@ -18,14 +23,32 @@ export async function compare({
   repo: string
   baseRef: string
   headRef: string
-}): Promise<Changes> {
+}): Promise<ComparisonResponse> {
+  let snapshot_warnings = ''
   const changes = await octo.paginate(
-    'GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}',
     {
+      method: 'GET',
+      url: '/repos/{owner}/{repo}/dependency-graph/compare/{basehead}',
       owner,
       repo,
-      basehead: `${baseRef}...${headRef}`
+      basehead: `${baseRef}...${headRef}`,
+      per_page: 5
+    },
+    response => {
+      if (
+        response.headers[SnapshotWarningsHeader] &&
+        typeof response.headers[SnapshotWarningsHeader] === 'string'
+      ) {
+        snapshot_warnings = Buffer.from(
+          response.headers[SnapshotWarningsHeader],
+          'base64'
+        ).toString('utf-8')
+      }
+      return ChangesSchema.parse(response.data)
     }
   )
-  return ChangesSchema.parse(changes)
+  return ComparisonResponseSchema.parse({
+    changes,
+    snapshot_warnings
+  })
 }

src/filter.ts

@@ -0,0 +1,102 @@
+import {Changes, Severity, SEVERITIES, Scope} from './schemas'
+
+/**
+ * Filters changes by a severity level. Only vulnerable
+ * dependencies will be returned.
+ *
+ * @param severity - The severity level to filter by.
+ * @param changes - The array of changes to filter.
+ * @returns The filtered array of changes that match the specified severity level and have vulnerabilities.
+ */
+export function filterChangesBySeverity(
+  severity: Severity,
+  changes: Changes
+): Changes {
+  const severityIdx = SEVERITIES.indexOf(severity)
+  let filteredChanges = []
+  for (const change of changes) {
+    if (
+      change === undefined ||
+      change.vulnerabilities === undefined ||
+      change.vulnerabilities.length === 0
+    ) {
+      continue
+    }
+
+    const fChange = {
+      ...change,
+      vulnerabilities: change.vulnerabilities.filter(vuln => {
+        const vulnIdx = SEVERITIES.indexOf(vuln.severity)
+        if (vulnIdx <= severityIdx) {
+          return true
+        }
+      })
+    }
+    filteredChanges.push(fChange)
+  }
+
+  // don't want to deal with changes with no vulnerabilities
+  filteredChanges = filteredChanges.filter(
+    change => change.vulnerabilities.length > 0
+  )
+
+  // only report vulnerability additions
+  return filteredChanges.filter(
+    change =>
+      change.change_type === 'added' &&
+      change.vulnerabilities !== undefined &&
+      change.vulnerabilities.length > 0
+  )
+}
+
+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
+}
+
+/**
+ * Filter out changes that are allowed by the allow_ghsas config
+ * option. We want to remove these changes before we do any
+ * processing.
+ * @param ghsas - list of GHSA IDs to allow
+ * @param changes - list of changes to filter
+ * @returns a list of changes with the allowed GHSAs removed
+ */
+export function filterAllowedAdvisories(
+  ghsas: string[] | undefined,
+  changes: Changes
+): Changes {
+  if (ghsas === undefined) {
+    return changes
+  }
+
+  const filteredChanges = changes.map(change => {
+    const noAdvisories =
+      change.vulnerabilities === undefined ||
+      change.vulnerabilities.length === 0
+
+    if (noAdvisories) {
+      return change
+    }
+    const newChange = {...change}
+    newChange.vulnerabilities = change.vulnerabilities.filter(
+      vuln => !ghsas.includes(vuln.advisory_ghsa_id)
+    )
+
+    return newChange
+  })
+
+  return filteredChanges
+}

src/git-refs.ts

@@ -0,0 +1,45 @@
+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, `base-ref`/`head-ref` workflow action 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, ' +
+        '`base-ref` workflow action 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, ' +
+        '`head-ref` workflow action option, or by running a ' +
+        'or by running a `pull_request`/`pull_request_target` workflow.'
+    )
+  }
+
+  return {
+    base: base_ref,
+    head: head_ref
+  }
+}

src/licenses.ts

@@ -0,0 +1,216 @@
+import spdxSatisfies from 'spdx-satisfies'
+import {Change, Changes} from './schemas'
+import {isSPDXValid, octokitClient} from './utils'
+import {PackageURL} from 'packageurl-js'
+
+/**
+ * Loops through a list of changes, filtering and returning the
+ * ones that don't conform to the licenses allow/deny lists.
+ * It will also filter out the changes which are defined in the licenseExclusions list.
+ *
+ * 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[], licenseExclusions?: string[]}} licenses An object with `allow`/`deny`/`licenseExclusions` keys, each containing a list of licenses.
+ * @returns {Promise<{Object.<string, Array.<Change>>}} A promise to a Record Object. The keys are strings, unlicensed, unresolved and forbidden. The values are a list of changes
+ */
+export type InvalidLicenseChangeTypes =
+  | 'unlicensed'
+  | 'unresolved'
+  | 'forbidden'
+export type InvalidLicenseChanges = Record<InvalidLicenseChangeTypes, Changes>
+export async function getInvalidLicenseChanges(
+  changes: Change[],
+  licenses: {
+    allow?: string[]
+    deny?: string[]
+    licenseExclusions?: string[]
+  }
+): Promise<InvalidLicenseChanges> {
+  const {allow, deny} = licenses
+  const licenseExclusions = licenses.licenseExclusions?.map(
+    (pkgUrl: string) => {
+      return PackageURL.fromString(encodeURI(pkgUrl))
+    }
+  )
+
+  const groupedChanges = await groupChanges(changes)
+
+  // Takes the changes from the groupedChanges object and filters out the ones that are part of the exclusions list
+  // It does by creating a new PackageURL object from the change and comparing it to the exclusions list
+  groupedChanges.licensed = groupedChanges.licensed.filter(change => {
+    if (change.package_url.length === 0) {
+      return true
+    }
+
+    const changeAsPackageURL = PackageURL.fromString(
+      encodeURI(change.package_url)
+    )
+
+    // We want to find if the licenseExclussion list contains the PackageURL of the Change
+    // If it does, we want to filter it out and therefore return false
+    // If it doesn't, we want to keep it and therefore return true
+    if (
+      licenseExclusions !== null &&
+      licenseExclusions !== undefined &&
+      licenseExclusions.findIndex(
+        exclusion =>
+          exclusion.type === changeAsPackageURL.type &&
+          exclusion.name === changeAsPackageURL.name
+      ) !== -1
+    ) {
+      return false
+    } else {
+      return true
+    }
+  })
+  const licensedChanges: Changes = groupedChanges.licensed
+
+  const invalidLicenseChanges: InvalidLicenseChanges = {
+    unlicensed: groupedChanges.unlicensed,
+    unresolved: [],
+    forbidden: []
+  }
+
+  const validityCache = new Map<string, boolean>()
+
+  for (const change of licensedChanges) {
+    const license = change.license
+
+    // should never happen since licensedChanges always have licenses but license is nullable in changes schema
+    if (license === null) {
+      continue
+    }
+
+    if (license === 'NOASSERTION') {
+      invalidLicenseChanges.unlicensed.push(change)
+    } else if (validityCache.get(license) === undefined) {
+      try {
+        if (allow !== undefined) {
+          const found = allow.find(spdxExpression =>
+            spdxSatisfies(license, spdxExpression)
+          )
+          validityCache.set(license, found !== undefined)
+        } else if (deny !== undefined) {
+          const found = deny.find(spdxExpression =>
+            spdxSatisfies(license, spdxExpression)
+          )
+          validityCache.set(license, found === undefined)
+        }
+      } catch (err) {
+        invalidLicenseChanges.unresolved.push(change)
+      }
+    }
+
+    if (validityCache.get(license) === false) {
+      invalidLicenseChanges.forbidden.push(change)
+    }
+  }
+
+  return invalidLicenseChanges
+}
+
+const fetchGHLicense = async (
+  owner: string,
+  repo: string
+): Promise<string | null> => {
+  try {
+    const response = await octokitClient().rest.licenses.getForRepo({
+      owner,
+      repo
+    })
+    return response.data.license?.spdx_id ?? null
+  } catch (_) {
+    return null
+  }
+}
+
+const parseGitHubURL = (url: string): {owner: string; repo: string} | null => {
+  try {
+    const parsed = new URL(url)
+    if (parsed.host !== 'github.com') {
+      return null
+    }
+    const components = parsed.pathname.split('/')
+    if (components.length < 3) {
+      return null
+    }
+    return {owner: components[1], repo: components[2]}
+  } catch (_) {
+    return null
+  }
+}
+
+const setGHLicenses = async (changes: Change[]): Promise<Change[]> => {
+  const updatedChanges = changes.map(async change => {
+    if (change.license !== null || change.source_repository_url === null) {
+      return change
+    }
+
+    const githubUrl = parseGitHubURL(change.source_repository_url)
+
+    if (githubUrl === null) {
+      return change
+    }
+
+    return {
+      ...change,
+      license: await fetchGHLicense(githubUrl.owner, githubUrl.repo)
+    }
+  })
+
+  return Promise.all(updatedChanges)
+}
+// Currently Dependency Graph licenses are truncated to 255 characters
+// This possibly makes them invalid spdx ids
+const truncatedDGLicense = (license: string): boolean =>
+  license.length === 255 && !isSPDXValid(license)
+
+async function groupChanges(
+  changes: Changes
+): Promise<Record<string, Changes>> {
+  const result: Record<string, Changes> = {
+    licensed: [],
+    unlicensed: []
+  }
+
+  const ghChanges = []
+
+  for (const change of changes) {
+    if (change.change_type === 'removed') {
+      continue
+    }
+
+    if (change.license === null) {
+      if (change.source_repository_url !== null) {
+        ghChanges.push(change)
+      } else {
+        result.unlicensed.push(change)
+      }
+    } else {
+      if (
+        truncatedDGLicense(change.license) &&
+        change.source_repository_url !== null
+      ) {
+        ghChanges.push(change)
+      } else {
+        result.licensed.push(change)
+      }
+    }
+  }
+
+  if (ghChanges.length > 0) {
+    const ghLicenses = await setGHLicenses(ghChanges)
+    for (const change of ghLicenses) {
+      if (change.license === null) {
+        result.unlicensed.push(change)
+      } else {
+        result.licensed.push(change)
+      }
+    }
+  }
+
+  return result
+}

src/main.ts

@@ -3,65 +3,305 @@ import * as dependencyGraph from './dependency-graph'
 import * as github from '@actions/github'
 import styles from 'ansi-styles'
 import {RequestError} from '@octokit/request-error'
-import {PullRequestSchema} from './schemas'
+import {
+  Change,
+  Severity,
+  Changes,
+  ConfigurationOptions,
+  Scorecard
+} from './schemas'
+import {readConfig} from '../src/config'
+import {
+  filterChangesBySeverity,
+  filterChangesByScopes,
+  filterAllowedAdvisories
+} from '../src/filter'
+import {getInvalidLicenseChanges} from './licenses'
+import {getScorecardLevels} from './scorecard'
+import * as summary from './summary'
+import {getRefs} from './git-refs'
+
+import {groupDependenciesByManifest} from './utils'
+import {commentPr} from './comment-pr'
+import {getDeniedChanges} from './deny'
+
+async function delay(ms: number): Promise<void> {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}
+
+async function getComparison(
+  baseRef: string,
+  headRef: string,
+  retryOpts?: {
+    retryUntil: number
+    retryDelay: number
+  }
+): ReturnType<typeof dependencyGraph.compare> {
+  const comparison = await dependencyGraph.compare({
+    owner: github.context.repo.owner,
+    repo: github.context.repo.repo,
+    baseRef,
+    headRef
+  })
+
+  if (comparison.snapshot_warnings.trim() !== '') {
+    core.info(comparison.snapshot_warnings)
+    if (retryOpts !== undefined) {
+      if (retryOpts.retryUntil < Date.now()) {
+        core.info(`Retry timeout exceeded. Proceeding...`)
+        return comparison
+      } else {
+        core.info(`Retrying in ${retryOpts.retryDelay} seconds...`)
+        await delay(retryOpts.retryDelay * 1000)
+        return getComparison(baseRef, headRef, retryOpts)
+      }
+    }
+  }
+
+  return comparison
+}
 
 async function run(): Promise<void> {
   try {
-    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 config = await readConfig()
 
-    const pull_request = PullRequestSchema.parse(
-      github.context.payload.pull_request
+    const refs = getRefs(config, github.context)
+
+    const comparison = await getComparison(
+      refs.base,
+      refs.head,
+      config.retry_on_snapshot_warnings
+        ? {
+            retryUntil:
+              Date.now() + config.retry_on_snapshot_warnings_timeout * 1000,
+            retryDelay: 10
+          }
+        : undefined
     )
 
-    const changes = await dependencyGraph.compare({
-      owner: github.context.repo.owner,
-      repo: github.context.repo.repo,
-      baseRef: pull_request.base.sha,
-      headRef: pull_request.head.sha
-    })
+    const changes = comparison.changes
+    const snapshot_warnings = comparison.snapshot_warnings
 
-    let failed = false
+    if (!changes) {
+      core.info('No Dependency Changes found. Skipping Dependency Review.')
+      return
+    }
 
-    for (const change of changes) {
-      if (
-        change.change_type === 'added' &&
-        change.vulnerabilities !== undefined &&
-        change.vulnerabilities.length > 0
-      ) {
-        for (const vuln of change.vulnerabilities) {
-          core.info(
-            `${styles.bold.open}${change.manifest} » ${change.name}@${
-              change.version
-            }${styles.bold.close} – ${vuln.advisory_summary} ${renderSeverity(
-              vuln.severity
-            )}`
-          )
-          core.info(`  ↪ ${vuln.advisory_url}`)
-        }
-        failed = true
+    const scopedChanges = filterChangesByScopes(config.fail_on_scopes, changes)
+
+    const filteredChanges = filterAllowedAdvisories(
+      config.allow_ghsas,
+      scopedChanges
+    )
+
+    const failOnSeverityParams = config.fail_on_severity
+    const warnOnly = config.warn_only
+    let minSeverity: Severity = 'low'
+    // If failOnSeverityParams is not set or warnOnly is true, the minSeverity is low, to allow all vulnerabilities to be reported as warnings
+    if (failOnSeverityParams && !warnOnly) {
+      minSeverity = failOnSeverityParams
+    }
+
+    const vulnerableChanges = filterChangesBySeverity(
+      minSeverity,
+      filteredChanges
+    )
+
+    const invalidLicenseChanges = await getInvalidLicenseChanges(
+      filteredChanges,
+      {
+        allow: config.allow_licenses,
+        deny: config.deny_licenses,
+        licenseExclusions: config.allow_dependencies_licenses
       }
+    )
+
+    core.debug(`Filtered Changes: ${JSON.stringify(filteredChanges)}`)
+    core.debug(`Config Deny Packages: ${JSON.stringify(config)}`)
+
+    const deniedChanges = await getDeniedChanges(
+      filteredChanges,
+      config.deny_packages,
+      config.deny_groups
+    )
+
+    const scorecard = await getScorecardLevels(filteredChanges)
+
+    summary.addSummaryToSummary(
+      vulnerableChanges,
+      invalidLicenseChanges,
+      deniedChanges,
+      scorecard,
+      config
+    )
+
+    if (snapshot_warnings) {
+      summary.addSnapshotWarnings(config, snapshot_warnings)
     }
 
-    if (failed) {
-      throw new Error('Dependency review detected vulnerable packages.')
-    } else {
-      core.info('Dependency review did not detect any vulnerable packages.')
+    if (config.vulnerability_check) {
+      core.setOutput('vulnerable-changes', JSON.stringify(vulnerableChanges))
+      summary.addChangeVulnerabilitiesToSummary(vulnerableChanges, minSeverity)
+      printVulnerabilitiesBlock(vulnerableChanges, minSeverity, warnOnly)
     }
+    if (config.license_check) {
+      core.setOutput(
+        'invalid-license-changes',
+        JSON.stringify(invalidLicenseChanges)
+      )
+      summary.addLicensesToSummary(invalidLicenseChanges, config)
+      printLicensesBlock(invalidLicenseChanges, warnOnly)
+    }
+    if (config.deny_packages || config.deny_groups) {
+      core.setOutput('denied-changes', JSON.stringify(deniedChanges))
+      summary.addDeniedToSummary(deniedChanges)
+      printDeniedDependencies(deniedChanges, config)
+    }
+    if (config.show_openssf_scorecard) {
+      summary.addScorecardToSummary(scorecard, config)
+      printScorecardBlock(scorecard, config)
+      createScorecardWarnings(scorecard, config)
+    }
+
+    core.setOutput('dependency-changes', JSON.stringify(changes))
+    summary.addScannedDependencies(changes)
+    printScannedDependencies(changes)
+    await commentPr(core.summary, config)
   } catch (error) {
     if (error instanceof RequestError && error.status === 404) {
       core.setFailed(
-        `Dependency review is not supported on this repository. Please ensure that Dependency graph is enabled, see https://github.com/${github.context.repo.owner}/${github.context.repo.repo}/settings/security_analysis`
+        `Dependency review could not obtain dependency data for the specified owner, repository, or revision range.`
       )
-    } else if (error instanceof Error) {
-      core.setFailed(error.message)
+    } else if (error instanceof RequestError && error.status === 403) {
+      core.setFailed(
+        `Dependency review is not supported on this repository. Please ensure that Dependency graph is enabled along with GitHub Advanced Security on private repositories, see https://github.com/${github.context.repo.owner}/${github.context.repo.repo}/settings/security_analysis`
+      )
+    } else {
+      if (error instanceof Error) {
+        core.setFailed(error.message)
+      } else {
+        core.setFailed('Unexpected fatal error')
+      }
     }
+  } finally {
+    await core.summary.write()
   }
 }
 
+function printVulnerabilitiesBlock(
+  addedChanges: Changes,
+  minSeverity: Severity,
+  warnOnly: boolean
+): void {
+  let vulFound = false
+  core.group('Vulnerabilities', async () => {
+    if (addedChanges.length > 0) {
+      for (const change of addedChanges) {
+        printChangeVulnerabilities(change)
+      }
+      vulFound = true
+    }
+
+    if (vulFound) {
+      const msg = 'Dependency review detected vulnerable packages.'
+      if (warnOnly) {
+        core.warning(msg)
+      } else {
+        core.setFailed(msg)
+      }
+    } else {
+      core.info(
+        `Dependency review did not detect any vulnerable packages with severity level "${minSeverity}" or higher.`
+      )
+    }
+  })
+}
+
+function printChangeVulnerabilities(change: Change): void {
+  for (const vuln of change.vulnerabilities) {
+    core.info(
+      `${styles.bold.open}${change.manifest} » ${change.name}@${
+        change.version
+      }${styles.bold.close} – ${vuln.advisory_summary} ${renderSeverity(
+        vuln.severity
+      )}`
+    )
+    core.info(`  ↪ ${vuln.advisory_url}`)
+  }
+}
+
+function printLicensesBlock(
+  invalidLicenseChanges: Record<string, Changes>,
+  warnOnly: boolean
+): void {
+  core.group('Licenses', async () => {
+    if (invalidLicenseChanges.forbidden.length > 0) {
+      core.info('\nThe following dependencies have incompatible licenses:')
+      printLicensesError(invalidLicenseChanges.forbidden)
+      const msg = 'Dependency review detected incompatible licenses.'
+      if (warnOnly) {
+        core.warning(msg)
+      } else {
+        core.setFailed(msg)
+      }
+    }
+    if (invalidLicenseChanges.unresolved.length > 0) {
+      core.warning(
+        '\nThe validity of the licenses of the dependencies below could not be determined. Ensure that they are valid SPDX licenses:'
+      )
+      printLicensesError(invalidLicenseChanges.unresolved)
+      core.setFailed(
+        'Dependency review could not detect the validity of all licenses.'
+      )
+    }
+    printNullLicenses(invalidLicenseChanges.unlicensed)
+  })
+}
+
+function printLicensesError(changes: Changes): void {
+  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: Changes): void {
+  if (changes.length === 0) {
+    return
+  }
+
+  core.info('\nWe could not detect a license for the following dependencies:')
+  for (const change of changes) {
+    core.info(
+      `${styles.bold.open}${change.manifest} » ${change.name}@${change.version}${styles.bold.close}`
+    )
+  }
+}
+
+function printScorecardBlock(
+  scorecard: Scorecard,
+  config: ConfigurationOptions
+): void {
+  core.group('Scorecard', async () => {
+    if (scorecard) {
+      for (const dependency of scorecard.dependencies) {
+        if (
+          dependency.scorecard?.score &&
+          dependency.scorecard?.score < config.warn_on_openssf_scorecard_level
+        ) {
+          core.info(
+            `${styles.color.red.open}${dependency.change.ecosystem}/${dependency.change.name}: OpenSSF Scorecard Score: ${dependency?.scorecard?.score}${styles.red.close}`
+          )
+        }
+        core.info(
+          `${dependency.change.ecosystem}/${dependency.change.name}: OpenSSF Scorecard Score: ${dependency?.scorecard?.score}`
+        )
+      }
+    }
+  })
+}
+
 function renderSeverity(
   severity: 'critical' | 'high' | 'moderate' | 'low'
 ): string {
@@ -76,4 +316,78 @@ 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.name}@${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)}`)
+      }
+    }
+  })
+}
+
+function printDeniedDependencies(
+  changes: Change[],
+  config: ConfigurationOptions
+): void {
+  core.group('Denied', async () => {
+    for (const denied of config.deny_packages) {
+      core.info(`Config: ${denied}`)
+    }
+
+    for (const change of changes) {
+      core.info(`Change: ${change.name}@${change.version} is denied`)
+      core.info(`Change: ${change.package_url} is denied`)
+    }
+  })
+}
+
+async function createScorecardWarnings(
+  scorecards: Scorecard,
+  config: ConfigurationOptions
+): Promise<void> {
+  // Iterate through the list of scorecards, and if the score is less than the threshold, send a warning
+  for (const dependency of scorecards.dependencies) {
+    if (
+      dependency.scorecard?.score &&
+      dependency.scorecard?.score < config.warn_on_openssf_scorecard_level
+    ) {
+      core.warning(
+        `${dependency.change.ecosystem}/${dependency.change.name} has an OpenSSF Scorecard of ${dependency.scorecard?.score}, which is less than this repository's threshold of ${config.warn_on_openssf_scorecard_level}.`,
+        {
+          title: 'OpenSSF Scorecard Warning'
+        }
+      )
+    }
+  }
+}
+
 run()

src/schemas.ts

@@ -1,6 +1,11 @@
 import * as z from 'zod'
 
-const ChangeSchema = z.object({
+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']),
   manifest: z.string(),
   ecosystem: z.string(),
@@ -9,16 +14,18 @@ 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: z.enum(['critical', 'high', 'moderate', 'low']),
+        severity: SeveritySchema,
         advisory_ghsa_id: z.string(),
         advisory_summary: z.string(),
         advisory_url: z.string()
       })
     )
     .optional()
+    .default([])
 })
 
 export const PullRequestSchema = z.object({
@@ -27,6 +34,119 @@ export const PullRequestSchema = z.object({
   head: z.object({sha: z.string()})
 })
 
-export const ChangesSchema = z.array(ChangeSchema)
+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_dependencies_licenses: z.array(z.string()).optional(),
+    allow_ghsas: z.array(z.string()).default([]),
+    deny_packages: z.array(z.string()).default([]),
+    deny_groups: 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(),
+    retry_on_snapshot_warnings: z.boolean().default(false),
+    retry_on_snapshot_warnings_timeout: z.number().default(120),
+    show_openssf_scorecard: z.boolean().optional().default(true),
+    warn_on_openssf_scorecard_level: z.number().default(3),
+    comment_summary_in_pr: z
+      .union([
+        z.preprocess(
+          val => (val === 'true' ? true : val === 'false' ? false : val),
+          z.boolean()
+        ),
+        z.enum(['always', 'never', 'on-failure'])
+      ])
+      .default('never'),
+    warn_only: z.boolean().default(false)
+  })
+  .transform(config => {
+    if (config.comment_summary_in_pr === true) {
+      config.comment_summary_in_pr = 'always'
+    } else if (config.comment_summary_in_pr === false) {
+      config.comment_summary_in_pr = 'never'
+    }
+    return config
+  })
+  .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"
+      })
+    }
+  })
 
+export const ChangesSchema = z.array(ChangeSchema)
+export const ComparisonResponseSchema = z.object({
+  changes: z.array(ChangeSchema),
+  snapshot_warnings: z.string()
+})
+
+export const ScorecardApiSchema = z.object({
+  date: z.string(),
+  repo: z
+    .object({
+      name: z.string(),
+      commit: z.string()
+    })
+    .nullish(),
+  scorecard: z
+    .object({
+      version: z.string(),
+      commit: z.string()
+    })
+    .nullish(),
+  checks: z
+    .array(
+      z.object({
+        name: z.string(),
+        documentation: z.object({
+          shortDescription: z.string(),
+          url: z.string()
+        }),
+        score: z.string(),
+        reason: z.string(),
+        details: z.array(z.string())
+      })
+    )
+    .nullish(),
+  score: z.number().nullish()
+})
+
+export const ScorecardSchema = z.object({
+  dependencies: z.array(
+    z.object({
+      change: ChangeSchema,
+      scorecard: ScorecardApiSchema.nullish()
+    })
+  )
+})
+
+export type Change = z.infer<typeof ChangeSchema>
 export type Changes = z.infer<typeof ChangesSchema>
+export type ComparisonResponse = z.infer<typeof ComparisonResponseSchema>
+export type ConfigurationOptions = z.infer<typeof ConfigurationOptionsSchema>
+export type Severity = z.infer<typeof SeveritySchema>
+export type Scope = (typeof SCOPES)[number]
+export type Scorecard = z.infer<typeof ScorecardSchema>
+export type ScorecardApi = z.infer<typeof ScorecardApiSchema>

src/scorecard.ts

@@ -0,0 +1,73 @@
+import {Change, Scorecard, ScorecardApi} from './schemas'
+import * as core from '@actions/core'
+
+export async function getScorecardLevels(
+  changes: Change[]
+): Promise<Scorecard> {
+  const data: Scorecard = {dependencies: []} as Scorecard
+  for (const change of changes) {
+    const ecosystem = change.ecosystem
+    const packageName = change.name
+    const version = change.version
+
+    //Get the project repository
+    let repositoryUrl = change.source_repository_url
+    //If the repository_url includes the protocol, remove it
+    if (repositoryUrl?.startsWith('https://')) {
+      repositoryUrl = repositoryUrl.replace('https://', '')
+    }
+
+    // If GitHub API doesn't have the repository URL, query deps.dev for it.
+    if (repositoryUrl) {
+      // Call the deps.dev API to get the repository URL from there
+      repositoryUrl = await getProjectUrl(ecosystem, packageName, version)
+    }
+
+    // Get the scorecard API response from the scorecards API
+    let scorecardApi: ScorecardApi | null = null
+    if (repositoryUrl) {
+      try {
+        scorecardApi = await getScorecard(repositoryUrl)
+      } catch (error: unknown) {
+        core.debug(`Error querying for scorecard: ${(error as Error).message}`)
+      }
+    }
+    data.dependencies.push({
+      change,
+      scorecard: scorecardApi
+    })
+  }
+  return data
+}
+
+async function getScorecard(repositoryUrl: string): Promise<ScorecardApi> {
+  const apiRoot = 'https://api.securityscorecards.dev/'
+  let scorecardResponse: ScorecardApi = {} as ScorecardApi
+
+  const url = `${apiRoot}/projects/${repositoryUrl}`
+  const response = await fetch(url)
+  if (response.ok) {
+    scorecardResponse = await response.json()
+  } else {
+    core.debug(`Couldn't get scorecard data for ${repositoryUrl}`)
+  }
+  return scorecardResponse
+}
+
+export async function getProjectUrl(
+  ecosystem: string,
+  packageName: string,
+  version: string
+): Promise<string> {
+  core.debug(`Getting deps.dev data for ${packageName} ${version}`)
+  const depsDevAPIRoot = 'https://api.deps.dev'
+  const url = `${depsDevAPIRoot}/v3alpha/systems/${ecosystem}/packages/${packageName}/versions/${version}`
+  const response = await fetch(url)
+  if (response.ok) {
+    const data = await response.json()
+    if (data.relatedProjects.length > 0) {
+      return data.relatedProjects[0].projectKey.id
+    }
+  }
+  return ''
+}

src/summary.ts

@@ -0,0 +1,385 @@
+import * as core from '@actions/core'
+import {ConfigurationOptions, Changes, Change, Scorecard} from './schemas'
+import {SummaryTableRow} from '@actions/core/lib/summary'
+import {InvalidLicenseChanges, InvalidLicenseChangeTypes} from './licenses'
+import {groupDependenciesByManifest, getManifestsSet, renderUrl} from './utils'
+
+const icons = {
+  check: '✅',
+  cross: '❌',
+  warning: '⚠️'
+}
+
+export function addSummaryToSummary(
+  vulnerableChanges: Changes,
+  invalidLicenseChanges: InvalidLicenseChanges,
+  deniedChanges: Changes,
+  scorecard: Scorecard,
+  config: ConfigurationOptions
+): void {
+  const scorecardWarnings = countScorecardWarnings(scorecard, config)
+  const licenseIssues = countLicenseIssues(invalidLicenseChanges)
+
+  core.summary.addHeading('Dependency Review', 1)
+
+  if (
+    vulnerableChanges.length === 0 &&
+    licenseIssues === 0 &&
+    deniedChanges.length === 0 &&
+    scorecardWarnings === 0
+  ) {
+    const issueTypes = [
+      config.vulnerability_check ? 'vulnerabilities' : '',
+      config.license_check ? 'license issues' : '',
+      config.show_openssf_scorecard ? 'OpenSSF Scorecard issues' : ''
+    ]
+    if (issueTypes.filter(Boolean).length === 0) {
+      core.summary.addRaw(`${icons.check} No issues found.`)
+    } else {
+      core.summary.addRaw(
+        `${icons.check} No ${issueTypes.filter(Boolean).join(' or ')} found.`
+      )
+    }
+
+    return
+  }
+
+  core.summary
+    .addRaw('The following issues were found:')
+    .addList([
+      ...(config.vulnerability_check
+        ? [
+            `${checkOrFailIcon(vulnerableChanges.length)} ${
+              vulnerableChanges.length
+            } vulnerable package(s)`
+          ]
+        : []),
+      ...(config.license_check
+        ? [
+            `${checkOrFailIcon(invalidLicenseChanges.forbidden.length)} ${
+              invalidLicenseChanges.forbidden.length
+            } package(s) with incompatible licenses`,
+            `${checkOrFailIcon(invalidLicenseChanges.unresolved.length)} ${
+              invalidLicenseChanges.unresolved.length
+            } package(s) with invalid SPDX license definitions`,
+            `${checkOrWarnIcon(invalidLicenseChanges.unlicensed.length)} ${
+              invalidLicenseChanges.unlicensed.length
+            } package(s) with unknown licenses.`
+          ]
+        : []),
+      ...(deniedChanges.length > 0
+        ? [
+            `${checkOrWarnIcon(deniedChanges.length)} ${
+              deniedChanges.length
+            } package(s) denied.`
+          ]
+        : []),
+      ...(config.show_openssf_scorecard && scorecardWarnings > 0
+        ? [
+            `${checkOrWarnIcon(scorecardWarnings)} ${scorecardWarnings ? scorecardWarnings : 'No'} packages with OpenSSF Scorecard issues.`
+          ]
+        : [])
+    ])
+    .addRaw('See the Details below.')
+}
+
+function countScorecardWarnings(
+  scorecard: Scorecard,
+  config: ConfigurationOptions
+): number {
+  return scorecard.dependencies.reduce(
+    (total, dependency) =>
+      total +
+      (dependency.scorecard?.score &&
+      dependency.scorecard?.score < config.warn_on_openssf_scorecard_level
+        ? 1
+        : 0),
+    0
+  )
+}
+
+export function addChangeVulnerabilitiesToSummary(
+  vulnerableChanges: Changes,
+  severity: string
+): void {
+  if (vulnerableChanges.length === 0) {
+    return
+  }
+
+  const rows: SummaryTableRow[] = []
+
+  const manifests = getManifestsSet(vulnerableChanges)
+
+  core.summary.addHeading('Vulnerabilities', 2)
+
+  for (const manifest of manifests) {
+    for (const change of vulnerableChanges.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>`, 4).addTable([
+      [
+        {data: 'Name', header: true},
+        {data: 'Version', header: true},
+        {data: 'Vulnerability', header: true},
+        {data: 'Severity', header: true}
+      ],
+      ...rows
+    ])
+  }
+
+  if (severity !== 'low') {
+    core.summary.addQuote(
+      `Only included vulnerabilities with severity <strong>${severity}</strong> or higher.`
+    )
+  }
+}
+
+export function addLicensesToSummary(
+  invalidLicenseChanges: InvalidLicenseChanges,
+  config: ConfigurationOptions
+): void {
+  if (countLicenseIssues(invalidLicenseChanges) === 0) {
+    return
+  }
+
+  core.summary.addHeading('License Issues', 2)
+  printLicenseViolations(invalidLicenseChanges)
+
+  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 (config.allow_dependencies_licenses) {
+    core.summary.addQuote(
+      `<strong>Excluded from license check</strong>: ${config.allow_dependencies_licenses.join(
+        ', '
+      )}`
+    )
+  }
+
+  core.debug(
+    `found ${invalidLicenseChanges.unlicensed.length} unknown licenses`
+  )
+
+  core.debug(
+    `${invalidLicenseChanges.unresolved.length} licenses could not be validated`
+  )
+}
+
+const licenseIssueTypes: InvalidLicenseChangeTypes[] = [
+  'forbidden',
+  'unresolved',
+  'unlicensed'
+]
+
+const issueTypeNames: Record<InvalidLicenseChangeTypes, string> = {
+  forbidden: 'Incompatible License',
+  unresolved: 'Invalid SPDX License',
+  unlicensed: 'Unknown License'
+}
+
+function printLicenseViolations(changes: InvalidLicenseChanges): void {
+  const rowsGroupedByManifest: Record<string, SummaryTableRow[]> = {}
+
+  for (const issueType of licenseIssueTypes) {
+    for (const change of changes[issueType]) {
+      if (!rowsGroupedByManifest[change.manifest]) {
+        rowsGroupedByManifest[change.manifest] = []
+      }
+      rowsGroupedByManifest[change.manifest].push([
+        renderUrl(change.source_repository_url, change.name),
+        change.version,
+        formatLicense(change.license),
+        issueTypeNames[issueType]
+      ])
+    }
+  }
+
+  for (const [manifest, rows] of Object.entries(rowsGroupedByManifest)) {
+    core.summary.addHeading(`<em>${manifest}</em>`, 4)
+    core.summary.addTable([
+      ['Package', 'Version', 'License', 'Issue Type'],
+      ...rows
+    ])
+  }
+}
+
+function formatLicense(license: string | null): string {
+  if (license === null || license === 'NOASSERTION') {
+    return 'Null'
+  }
+  return license
+}
+
+export function addScannedDependencies(changes: Changes): void {
+  const dependencies = groupDependenciesByManifest(changes)
+  const manifests = dependencies.keys()
+
+  const summary = core.summary.addHeading('Scanned Manifest Files', 2)
+
+  for (const manifest of manifests) {
+    const deps = dependencies.get(manifest)
+    if (deps) {
+      const dependencyNames = deps.map(
+        dependency => `<li>${dependency.name}@${dependency.version}</li>`
+      )
+      summary.addDetails(manifest, `<ul>${dependencyNames.join('')}</ul>`)
+    }
+  }
+}
+
+function snapshotWarningRecommendation(
+  config: ConfigurationOptions,
+  warnings: string
+): string {
+  const no_pr_snaps = warnings.includes(
+    'No snapshots were found for the head SHA'
+  )
+  const retries_disabled = !config.retry_on_snapshot_warnings
+  if (no_pr_snaps && retries_disabled) {
+    return 'Ensure that dependencies are being submitted on PR branches and consider enabling <em>retry-on-snapshot-warnings</em>.'
+  } else if (no_pr_snaps) {
+    return 'Ensure that dependencies are being submitted on PR branches. Re-running this action after a short time may resolve the issue.'
+  } else if (retries_disabled) {
+    return 'Consider enabling <em>retry-on-snapshot-warnings</em>.'
+  }
+  return 'Re-running this action after a short time may resolve the issue.'
+}
+
+export function addScorecardToSummary(
+  scorecard: Scorecard,
+  config: ConfigurationOptions
+): void {
+  core.summary.addHeading('OpenSSF Scorecard', 2)
+  if (scorecard.dependencies.length > 10) {
+    core.summary.addRaw(`<details><summary>Scorecard details</summary>`, true)
+  }
+  core.summary.addRaw(
+    `<table><tr><th>Package</th><th>Version</th><th>Score</th><th>Details</th></tr>`,
+    true
+  )
+  for (const dependency of scorecard.dependencies) {
+    core.debug('Adding scorecard to summary')
+    core.debug(`Overall score ${dependency.scorecard?.score}`)
+
+    // Set the icon based on the overall score value
+    let overallIcon = ''
+    if (dependency.scorecard?.score) {
+      overallIcon =
+        dependency.scorecard?.score < config.warn_on_openssf_scorecard_level
+          ? ':warning:'
+          : ':green_circle:'
+    }
+
+    //Add a row for the dependency
+    core.summary.addRaw(
+      `<tr><td>${dependency.change.source_repository_url ? `<a href="https://${dependency.change.source_repository_url}">` : ''} ${dependency.change.ecosystem}/${dependency.change.name} ${dependency.change.source_repository_url ? `</a>` : ''}</td><td>${dependency.change.version}</td>
+      <td>${overallIcon} ${dependency.scorecard?.score === undefined || dependency.scorecard?.score === null ? 'Unknown' : dependency.scorecard?.score}</td>`,
+      false
+    )
+
+    //Add details table in the last column
+    if (dependency.scorecard?.checks !== undefined) {
+      let detailsTable =
+        '<table><tr><th>Check</th><th>Score</th><th>Reason</th></tr>'
+      for (const check of dependency.scorecard?.checks || []) {
+        const icon =
+          parseFloat(check.score) < config.warn_on_openssf_scorecard_level
+            ? ':warning:'
+            : ':green_circle:'
+
+        detailsTable += `<tr><td>${check.name}</td><td>${icon} ${check.score}</td><td>${check.reason}</td></tr>`
+      }
+      detailsTable += `</table>`
+      core.summary.addRaw(
+        `<td><details><summary>Details</summary>${detailsTable}</details></td></tr>`,
+        true
+      )
+    } else {
+      core.summary.addRaw('<td>Unknown</td></tr>', true)
+    }
+  }
+  core.summary.addRaw(`</table>`)
+  if (scorecard.dependencies.length > 10) {
+    core.summary.addRaw(`</details>`)
+  }
+}
+
+export function addSnapshotWarnings(
+  config: ConfigurationOptions,
+  warnings: string
+): void {
+  core.summary.addHeading('Snapshot Warnings', 2)
+  core.summary.addQuote(`${icons.warning}: ${warnings}`)
+  const recommendation = snapshotWarningRecommendation(config, warnings)
+  const docsLink =
+    'See <a href="https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#best-practices-for-using-the-dependency-review-api-and-the-dependency-submission-api-together">the documentation</a> for more information and troubleshooting advice.'
+  core.summary.addRaw(`${recommendation} ${docsLink}`)
+}
+
+function countLicenseIssues(
+  invalidLicenseChanges: InvalidLicenseChanges
+): number {
+  return Object.values(invalidLicenseChanges).reduce(
+    (acc, val) => acc + val.length,
+    0
+  )
+}
+
+export function addDeniedToSummary(deniedChanges: Change[]): void {
+  if (deniedChanges.length === 0) {
+    return
+  }
+
+  core.summary.addHeading('Denied dependencies', 2)
+  for (const change of deniedChanges) {
+    core.summary.addHeading(`<em>Denied dependencies</em>`, 4)
+    core.summary.addTable([
+      ['Package', 'Version', 'License'],
+      [
+        renderUrl(change.source_repository_url, change.name),
+        change.version,
+        change.license || ''
+      ]
+    ])
+  }
+}
+
+function checkOrFailIcon(count: number): string {
+  return count === 0 ? icons.check : icons.cross
+}
+
+function checkOrWarnIcon(count: number): string {
+  return count === 0 ? icons.check : icons.warning
+}

src/utils.ts

@@ -0,0 +1,70 @@
+import * as core from '@actions/core'
+import {Octokit} from 'octokit'
+import spdxParse from 'spdx-expression-parse'
+import {Changes} from './schemas'
+
+export function groupDependenciesByManifest(
+  changes: Changes
+): Map<string, Changes> {
+  const dependencies: Map<string, Changes> = new Map()
+  for (const change of changes) {
+    // If the manifest is null or empty, give it a name now to avoid
+    // breaking the HTML rendering later
+    const manifestName = change.manifest || 'Unnamed 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
+  }
+}
+
+export function isSPDXValid(license: string): boolean {
+  try {
+    spdxParse(license)
+    return true
+  } catch (_) {
+    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)
+}

tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src"],
+  "compilerOptions": {
+    "outDir": "./lib" /* Redirect output structure to the directory. */,
+    "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+  }
+}

tsconfig.json

@@ -3,10 +3,9 @@
     "target": "es6" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
     "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
     "outDir": "./lib" /* Redirect output structure to the directory. */,
-    "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
     "strict": true /* Enable all strict type-checking options. */,
     "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
     "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
   },
-  "exclude": ["node_modules", "**/*.test.ts"]
+  "exclude": ["node_modules"]
 }