npm run package

more SPDX unit tests to illustrate matching behavior
update licenses pkg and tests
2024-06-06 14:34:59 -07:00 · 2024-06-06 14:34:55 -07:00 · 2024-06-05 23:38:18 -07:00 · 2024-06-05 23:38:18 -07:00 · 2024-06-05 23:38:18 -07:00 · 2024-06-05 23:38:14 -07:00
35 changed files with 4975 additions and 109836 deletions
@@ -1,7 +0,0 @@
 ## Purpose
 _Describe the purpose of this pull request_
 ## Related Issues
 _What issues does this PR close or relate to?_
@@ -12,14 +12,3 @@ updates:
    ignore:
      - dependency-name: '@types/node'
        update-types: ['version-update:semver-major']
    groups:
      minor-updates:
        update-types:
          - 'minor'
          - 'patch'
        exclude-patterns:
          - '*spdx*'
      # Pull out any updates to spdx definitions and parsing as a priority PR
      spdx-licenses:
        patterns:
          - '*spdx*'
@@ -16,9 +16,6 @@ on:
      - '**.md'
  workflow_dispatch:
 permissions:
  contents: read
 jobs:
  check-dist:
    runs-on: ubuntu-latest
@@ -10,9 +10,6 @@ on:
    paths-ignore:
      - '**.md'
 permissions:
  contents: read
 jobs:
  test:
    runs-on: ubuntu-latest
@@ -20,7 +20,7 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        language: [ 'javascript-typescript', 'actions', 'ruby' ]
+        language: [ 'javascript-typescript' ]
    steps:
    - name: Checkout repository
@@ -1,5 +1,4 @@
 name: 'Dependency Review'
 on: [pull_request]
 permissions:
@@ -12,4 +11,4 @@ jobs:
      - name: 'Checkout Repository'
        uses: actions/checkout@v4
      - name: Dependency Review
-        uses: ./
+        uses: actions/dependency-review-action@main
@@ -12,15 +12,12 @@ jobs:
  stale:
    runs-on: ubuntu-latest
    steps:
-    - uses: actions/stale@v9.1.0
+    - 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 for 180 days. You can: comment on the PR or remove the stale label to hold stalebot 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 stalebot. Please see CONTRIBUTING.md for more policy details."
+        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"
        close-pr-message: "👋 This pull request has been closed by stalebot because it has been open with no activity for over 180 days. Please see CONTRIBUTING.md for more policy details."
        stale-issue-label: "Stale"
        stale-issue-message: "👋 This issue has been marked as stale because it has been open with no activity for 180 days. You can: comment on the issue or remove the stale label to hold stalebot off for a while, add the `Keep` label to hold stale off permanently, or do nothing. If you do nothing, this issue will be closed eventually by the stalebot. Please see CONTRIBUTING.md for more policy details."
        close-issue-message: "👋 This issue has been closed by stalebot because it has been open with no activity for over 180 days. Please see CONTRIBUTING.md for more policy details."
        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
@@ -16,7 +16,7 @@ If you've encountered a problem, please let us know by [submitting an issue](htt
 ## Enhancements and feature requests
-If you've got an idea for a new feature or a significant change to the code or its dependencies, please submit as [an issue](https://github.com/actions/dependency-review-action/issues/new) so that the community can see it, and we can discuss it there. We may not be able to respond to every single issue, but will make a best effort!
+If you've got an idea for a new feature, please submit as [an issue](https://github.com/actions/dependency-review-action/issues/new) so that the community can see it, and we can discuss it there. We may not be able to respond to every single issue, but will make a best effort!
 If you'd like to make a contribution yourself, we ask that before significant effort is put into code changes, that we have agreement that the change aligns with our strategy for the action. Since this is a verified Action owned by GitHub we want to make sure that contributions are high quality, and that they maintain consistency with the rest of the action's behavior.
@@ -35,11 +35,11 @@ Ready to contribute to `dependency-review-action`?  Here is some information to
 This action makes an authenticated query to the [Dependency Review API](https://docs.github.com/en/rest/dependency-graph/dependency-review) endpoint (`GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}`) to find out the set of added and removed dependencies for each manifest.
-The action then evaluates the differences between the pushes based on the rules defined in the action configuration, and summarizes the differences and any violations of the rules you have defined as a comment in the pull request that triggered it and the action outputs.
+The action then evaluates the differences between the pushes based on the the rules defined in the action configuration, and summarizes the differences and any violations of the rules you have defined as a comment in the pull request that triggered it and the action outputs.
 ### Local Development
-Before you begin, you need to have [Node.js](https://nodejs.org/en/) installed, minimum version 20.
+Before you begin, you need to have [Node.js](https://nodejs.org/en/) installed, minimum version 18.
 #### Bootstrapping the project
@@ -81,7 +81,7 @@ $ GITHUB_TOKEN=<token> ./scripts/scan_pr --config-file my_custom_config.yml <pr_
 npm run test
 ```
-_Note_: We don't have a very comprehensive test suite, so any contributions to the existing tests are welcome!
+_Note_: We don't a very comprehensive test suite, so any contributions to the existing tests are welcome!
 ### Submitting a pull request
@@ -1,23 +1,13 @@
 # dependency-review-action
- [dependency-review-action](#dependency-review-action)
+- [Overview](#overview)
-  - [Overview](#overview)
+- [Installation](#installation)
-    - [Viewing the results](#viewing-the-results)
+- [Configuration](#configuration)
-  - [Installation](#installation)
+- [Using dependency review action to block a pull request from being merged](#using-dependency-review-action-to-block-a-pull-request-from-being-merged)
-      - [Installation (standard)](#installation-standard)
+- [Outputs](#outputs)
-      - [Installation (GitHub Enterprise Server)](#installation-github-enterprise-server)
+- [Getting help](#getting-help)
-  - [Configuration](#configuration)
+- [Contributing](#contributing)
-    - [Configuration options](#configuration-options)
+- [License](#license)
    - [Configuration methods](#configuration-methods)
      - [Option 1: Using inline configuration](#option-1-using-inline-configuration)
      - [Option 2: Using an external configuration file](#option-2-using-an-external-configuration-file)
      - [`OTHER` in license strings](#other-in-license-strings)
      - [Further information](#further-information)
  - [Using dependency review action to block a pull request from being merged](#using-dependency-review-action-to-block-a-pull-request-from-being-merged)
  - [Outputs](#outputs)
  - [Getting help](#getting-help)
  - [Contributing](#contributing)
  - [License](#license)
 ## Overview
@@ -25,7 +15,6 @@ The dependency review action scans your pull requests for dependency changes, an
 The action is supported by an [API endpoint](https://docs.github.com/en/rest/dependency-graph/dependency-review?apiVersion=2022-11-28) that diffs the dependencies between any two revisions on your default branch.
 The action is available for: 
 - Public repositories
 - Private repositories with a [GitHub Advanced Security](https://docs.github.com/en/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security) license.
@@ -37,7 +26,7 @@ When the action runs, you can see the results on:
  1. Go to the **Actions** tab for the repository and select the relevant workflow run. 
  1. Then under "Jobs", click **dependency review**.
-  <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">
+      <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">
 - The **job summary** page.
  1. Go to the **Actions** tab for the repository and select the relevant workflow run. 
@@ -81,7 +70,7 @@ You can install the action on repositories on GitHub Enterprise Server.
 2. Ensure you have installed the [dependency-review-action](https://github.com/actions/dependency-review-action) on the server.
 3. Add a new YAML workflow to your `.github/workflows` folder:
-   ```yaml
+   ``` yaml
   name: 'Dependency Review'
   on: [pull_request]
@@ -97,8 +86,7 @@ You can install the action on repositories on GitHub Enterprise Server.
         - name: 'Dependency Review'
           uses: actions/dependency-review-action@v4
   ```
-
+5. In the workflow file, replace the `runs-on` value with the label of any of your runners. (The default value is `self-hosted`.)
 4. In the workflow file, replace the `runs-on` value with the label of any of your runners. (The default value is `self-hosted`.)
 ## Configuration
@@ -111,28 +99,27 @@ There are various configuration options you can use to specify settings for the
 All configuration options are optional. 
-| Option                                 | Usage                                                                                                                                                                                                                                                                                                                                                              | Possible values                                                                                              | Default value |
+| 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`         |
+| `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          |
+| `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`\*                      | ⚠️ This option is deprecated for possible removal in the next major release. See [Deprecate the deny-licenses option #938](https://github.com/actions/dependency-review-action/issues/938) for more information. <br> 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          |
+| `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`     |
+| `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          |
+| `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`        |
+| `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`        |
+| `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          |
+| `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          |
+| `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. With each execution, a new comment will overwrite the existing one.                                                                                                                          | `always`, `on-failure`, `never`                                                                              | `never`       |
+| `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. This option will match on the exact version provided. If no version is provided, the option will treat the specified package as a wildcard and deny all versions.                                                                                                                                                         | Package(s) in [purl](https://github.com/package-url/purl-spec) format                                        | empty         |
+| `deny-packages`                        | Any number of packages to block in a PR. This option will match on the exact version provided. If no version is provided, the option will treat the specified package as a wildcard and deny all versions. | 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         |
+| `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`\*         | 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           |
+| `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`       |
+| `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`               | 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`        |
+| `show-openssf-scorecard`        | 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             |
+| `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             |
 > [!NOTE]
 >
 > - \* Not supported for use with GitHub Enterprise Server. (Checking for licenses is not supported on GitHub Enterprise Server because the API does not return license information.)
 > - \+ When `warn-only` is set to `true`, all vulnerabilities, independently of the severity, will be reported as warnings and the action will not fail.
 > - The `allow-licenses` and `deny-licenses` options are mutually exclusive; an error will be raised if you provide both.
@@ -141,7 +128,6 @@ All configuration options are optional.
 ### Configuration methods
 To specify settings for the dependency review action, you can choose from two options:
 - [Option 1: Inline the configuration options]() in your workflow file.
 - [Option 2: Reference an external configuration file]() in your workflow file.
@@ -150,7 +136,6 @@ To specify settings for the dependency review action, you can choose from two op
 You can pass configuration options to the dependency review action using your workflow file.
 1. In the same YAML workflow file you created during installation, use the `with:` key to specify your chosen settings:
   ```yaml
   name: 'Dependency Review'
   on: [pull_request]
@@ -193,42 +178,34 @@ You can use an external configuration file to specify settings for this action.
           with:
             config-file: './.github/dependency-review-config.yml'
   ```
-
+   | Option                | Usage    | Possible values | 
-   | 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` |
   | `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` |
 2. Optionally, if the file resides in a private external repository, and for all GitHub Enterprise Server repositories, use `external-repo-token` to specify a token for fetching the file.
   ```yaml
-   - name: Dependency Review
+    - name: Dependency Review
-     uses: actions/dependency-review-action@v4
+      uses: actions/dependency-review-action@v4
-     with:
+      with:
-       config-file: 'github/octorepo/dependency-review-config.yml@main'
+        config-file: 'github/octorepo/dependency-review-config.yml@main'
-       external-repo-token: 'ghp_123456789abcde'
+        external-repo-token: 'ghp_123456789abcde'
   ```
-   | Option                | Usage                                                                                                                                                                                                                                                     | Possible values                                                              |
+   | Option                | Usage    | Possible values | 
-   | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+   |--------------------- | ----------- | ----------------------------- |
   | `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. |
 3. Create the configuration file in the path you specified for `config-file`.
 4. In the configuration file, specify your chosen settings.
   ```yaml
-   fail-on-severity: 'critical'
+   fail_on_severity: 'critical'
-   allow-licenses:
+   allow_licenses:
     - 'GPL-3.0'
     - 'BSD-3-Clause'
     - 'MIT'
   ```
-
+> [!NOTE]
-#### `OTHER` in license strings
+> For external configuration files, the option names use underscores instead of dashes.
-
+> Example: `fail_on_severity`
 License data comes from [ClearlyDefined](https://clearlydefined.io) and you may sometimes see licenses displayed with the string `OTHER` in them. ClearlyDefined [defines OTHER](https://docs.clearlydefined.io/docs/curation/curation-guidelines) as:
 > This indicates that a human confirmed that there is license information in the file but that the license is not an SPDX-identified license.
 `OTHER` is not a valid [SPDX license identifier](https://spdx.org/licenses/), so we convert `OTHER` in a license string into `LicenseRef-clearlydefined-OTHER`, which _is_ valid in SPDX. If you want to add that to the deny or allow list, be sure to add `LicenseRef-clearlydefined-OTHER` to this list, because that is what we'll actually be comparing.
 #### Further information
@@ -124,78 +124,6 @@ test('it raises an error when no refs are provided and the event is not a pull r
  ).toThrow()
 })
 const pullRequestLikeEvents = ['pull_request', 'pull_request_target']
 test.each(pullRequestLikeEvents)(
  'it uses the given refs even when the event is %s',
  async eventName => {
    setInput('base-ref', 'a-custom-base-ref')
    setInput('head-ref', 'a-custom-head-ref')
    const refs = getRefs(await readConfig(), {
      payload: {
        pull_request: {
          number: 42,
          base: {sha: 'pr-base-ref'},
          head: {sha: 'pr-head-ref'}
        }
      },
      eventName
    })
    expect(refs.base).toEqual('a-custom-base-ref')
    expect(refs.head).toEqual('a-custom-head-ref')
  }
 )
 test.each(pullRequestLikeEvents)(
  'it uses the event refs when the event is %s and no refs are provided in config',
  async eventName => {
    const refs = getRefs(await readConfig(), {
      payload: {
        pull_request: {
          number: 42,
          base: {sha: 'pr-base-ref'},
          head: {sha: 'pr-head-ref'}
        }
      },
      eventName
    })
    expect(refs.base).toEqual('pr-base-ref')
    expect(refs.head).toEqual('pr-head-ref')
  }
 )
 test('it uses the given refs even when the event is merge_group', async () => {
  setInput('base-ref', 'a-custom-base-ref')
  setInput('head-ref', 'a-custom-head-ref')
  const refs = getRefs(await readConfig(), {
    payload: {
      merge_group: {
        base_sha: 'pr-base-ref',
        head_sha: 'pr-head-ref'
      }
    },
    eventName: 'merge_group'
  })
  expect(refs.base).toEqual('a-custom-base-ref')
  expect(refs.head).toEqual('a-custom-head-ref')
 })
 test('it uses the event refs when the event is merge_group and no refs are provided in config', async () => {
  const refs = getRefs(await readConfig(), {
    payload: {
      merge_group: {
        base_sha: 'pr-base-ref',
        head_sha: 'pr-head-ref'
      }
    },
    eventName: 'merge_group'
  })
  expect(refs.base).toEqual('pr-base-ref')
  expect(refs.head).toEqual('pr-head-ref')
 })
 test('it defaults to runtime scope', async () => {
  const config = await readConfig()
  expect(config.fail_on_scopes).toEqual(['runtime'])
@@ -134,62 +134,3 @@ test('allows packages not defined in the deny packages and groups list', async (
  expect(deniedChanges.length).toEqual(0)
 })
 test('deny packages does not prevent removal of denied packages', async () => {
  const changes: Changes = [
    createTestChange({
      change_type: 'added',
      name: 'deny-by-name-and-version',
      version: '1.0.0',
      ecosystem: 'npm'
    }),
    createTestChange({
      change_type: 'removed',
      name: 'pass-by-name-and-version',
      version: '1.0.0',
      ecosystem: 'npm'
    }),
    createTestChange({
      change_type: 'added',
      name: 'deny-by-name',
      version: '1.0.0',
      ecosystem: 'npm'
    }),
    createTestChange({
      change_type: 'removed',
      name: 'pass-by-name',
      version: '1.0.0',
      ecosystem: 'npm'
    }),
    createTestChange({
      change_type: 'added',
      package_url: 'pkg:npm/org.test.deny.by.namespace/[email protected]',
      ecosystem: 'npm'
    }),
    createTestChange({
      change_type: 'removed',
      package_url: 'pkg:npm/org.test.pass.by.namespace/[email protected]',
      ecosystem: 'npm'
    })
  ]
  const deniedPackages = createTestPURLs([
    'pkg:npm/org.test.deny.by/[email protected]',
    'pkg:npm/org.test.pass.by/[email protected]',
    'pkg:npm/org.test.deny.by/deny-by-name',
    'pkg:npm/org.test.pass.by/pass-by-name'
  ])
  const deniedGroups = createTestPURLs([
    'pkg:npm/org.test.deny.by.namespace/',
    'pkg:npm/org.test.pass.by.namespace/'
  ])
  const deniedChanges = await getDeniedChanges(
    changes,
    deniedPackages,
    deniedGroups
  )
  expect(deniedChanges.length).toEqual(3)
  expect(deniedChanges[0]).toBe(changes[0])
  expect(deniedChanges[1]).toBe(changes[2])
  expect(deniedChanges[2]).toBe(changes[4])
 })
@@ -74,46 +74,6 @@ const pipChange: Change = {
  ]
 }
 const complexLicenseChange: Change = {
  change_type: 'added',
  manifest: 'requirements.txt',
  ecosystem: 'pip',
  name: 'package-1',
  version: '1.1.1',
  package_url: 'pkg:pypi/[email protected]',
  license: 'MIT AND Apache-2.0',
  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 unlicensedChange: Change = {
  change_type: 'added',
  manifest: '.github/workflows/ci.yml',
  ecosystem: 'actions',
  name: 'foo-org/actions-repo/.github/workflows/some-action.yml',
  version: '1.1.1',
  package_url:
    'pkg:githubactions/foo-org/actions-repo/.github/workflows/[email protected]',
  license: null,
  source_repository_url: 'github.com/some-repo',
  scope: 'development',
  vulnerabilities: []
 }
 jest.mock('@actions/core')
 const mockOctokit = {
@@ -169,30 +129,6 @@ test('it adds license inside the deny list to forbidden changes', async () => {
  expect(forbidden.length).toEqual(1)
 })
 test('it handles allowed complex licenses', async () => {
  const changes: Changes = [
    complexLicenseChange // MIT AND Apache-2.0 license
  ]
  const {forbidden} = await getInvalidLicenseChanges(changes, {
    allow: ['MIT', 'Apache-2.0']
  })
  expect(forbidden.length).toEqual(0)
 })
 test('it handles complex licenses not all on the allow list', async () => {
  const changes: Changes = [
    complexLicenseChange // MIT AND Apache-2.0 license
  ]
  const {forbidden} = await getInvalidLicenseChanges(changes, {
    allow: ['MIT']
  })
  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'},
@@ -290,19 +226,6 @@ test('it does filters out changes if they are not on the exclusions list', async
  expect(invalidLicenses.forbidden[1]).toBe(npmChange)
 })
 test('it does not fail if there is a license expression in the allow list', async () => {
  const changes: Changes = [
    {...npmChange, license: 'MIT AND Apache-2.0'},
    {...rubyChange, license: 'BSD-3-Clause'}
  ]
  const {forbidden} = await getInvalidLicenseChanges(changes, {
    allow: ['BSD-3-Clause', 'MIT AND Apache-2.0', 'MIT', 'Apache-2.0']
  })
  expect(forbidden.length).toEqual(0)
 })
 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 = {
@@ -340,26 +263,4 @@ describe('GH License API fallback', () => {
    expect(mockOctokit.rest.licenses.getForRepo).not.toHaveBeenCalled()
    expect(unlicensed.length).toEqual(0)
  })
  test('it does not call licenses API if the package is excluded', async () => {
    const {unlicensed} = await getInvalidLicenseChanges([unlicensedChange], {
      licenseExclusions: [
        'pkg:githubactions/foo-org/actions-repo/.github/workflows/some-action.yml'
      ]
    })
    expect(mockOctokit.rest.licenses.getForRepo).not.toHaveBeenCalled()
    expect(unlicensed.length).toEqual(0)
  })
  test('it checks namespaces when doing exclusions', async () => {
    const {unlicensed} = await getInvalidLicenseChanges([unlicensedChange], {
      licenseExclusions: [
        'pkg:githubactions/bar-org/actions-repo/.github/workflows/some-action.yml'
      ]
    })
    expect(mockOctokit.rest.licenses.getForRepo).not.toHaveBeenCalled()
    expect(unlicensed.length).toEqual(1)
  })
 })
@@ -1,153 +0,0 @@
 import {
  afterEach,
  beforeEach,
  describe,
  expect,
  jest,
  test
 } from '@jest/globals'
 import * as fs from 'fs'
 import * as core from '@actions/core'
 import {DefaultArtifactClient} from '@actions/artifact'
 import type {SpyInstance} from 'jest-mock'
 import {handleLargeSummary} from '../src/main'
 jest.mock('ansi-styles', () => ({
  __esModule: true,
  default: {
    color: {
      red: {open: '', close: ''},
      yellow: {open: '', close: ''},
      grey: {open: '', close: ''},
      green: {open: '', close: ''}
    },
    bold: {open: '', close: ''}
  }
 }))
 jest.mock('../src/dependency-graph', () => ({}))
 jest.mock('@actions/core', () => {
  const summary = {
    addRaw: jest.fn().mockReturnThis(),
    addHeading: jest.fn().mockReturnThis(),
    addTable: jest.fn().mockReturnThis(),
    addSeparator: jest.fn().mockReturnThis(),
    addImage: jest.fn().mockReturnThis(),
    addList: jest.fn().mockReturnThis(),
    addBreak: jest.fn().mockReturnThis(),
    addLink: jest.fn().mockReturnThis(),
    addDetails: jest.fn().mockReturnThis(),
    addSection: jest.fn().mockReturnThis(),
    addCodeBlock: jest.fn().mockReturnThis(),
    addFields: jest.fn().mockReturnThis(),
    addEol: jest.fn().mockReturnThis(),
    write: jest.fn(async () => undefined),
    emptyBuffer: jest.fn(),
    stringify: jest.fn(() => '')
  }
  return {
    __esModule: true,
    getInput: jest.fn((name: string) =>
      name === 'repo-token' ? 'gh_test_token' : ''
    ),
    setOutput: jest.fn(),
    setFailed: jest.fn(),
    warning: jest.fn(),
    info: jest.fn(),
    debug: jest.fn(),
    startGroup: jest.fn(),
    endGroup: jest.fn(),
    group: jest.fn(async (_name: string, fn: () => Promise<unknown>) => fn()),
    summary
  }
 })
 jest.mock('@actions/artifact', () => ({
  DefaultArtifactClient: jest.fn()
 }))
 const ORIGINAL_ENV = {...process.env}
 type ArtifactClientInstance = {
  uploadArtifact: jest.Mock
 }
 const DefaultArtifactClientMock = DefaultArtifactClient as unknown as jest.Mock
 const createArtifactClient = (): ArtifactClientInstance => ({
  uploadArtifact: jest.fn(async () => undefined)
 })
 describe('handleLargeSummary', () => {
  let writeFileSpy: SpyInstance<typeof fs.promises.writeFile>
  beforeEach(() => {
    process.env = {...ORIGINAL_ENV}
    writeFileSpy = jest
      .spyOn(fs.promises, 'writeFile')
      .mockImplementation(async () => undefined)
    DefaultArtifactClientMock.mockClear()
    DefaultArtifactClientMock.mockImplementation(() => createArtifactClient())
  })
  afterEach(() => {
    writeFileSpy.mockRestore()
    jest.clearAllMocks()
    process.env = {...ORIGINAL_ENV}
  })
  test('returns original summary when under size threshold', async () => {
    const summaryContent = 'short summary'
    const result = await handleLargeSummary(summaryContent)
    expect(result).toBe(summaryContent)
    expect(writeFileSpy).not.toHaveBeenCalled()
    expect(DefaultArtifactClientMock).not.toHaveBeenCalled()
  })
  test('uploads artifact and returns minimal summary when summary is too large', async () => {
    process.env.GITHUB_SERVER_URL = 'https://github.com'
    process.env.GITHUB_REPOSITORY = 'owner/repo'
    process.env.GITHUB_RUN_ID = '12345'
    const largeSummary = 'a'.repeat(1024 * 1024 + 1)
    const result = await handleLargeSummary(largeSummary)
    expect(writeFileSpy).toHaveBeenCalledTimes(1)
    expect(writeFileSpy).toHaveBeenCalledWith('summary.md', largeSummary)
    expect(DefaultArtifactClientMock).toHaveBeenCalledTimes(1)
    const artifactInstance = DefaultArtifactClientMock.mock.results[0]
      ?.value as ArtifactClientInstance
    expect(artifactInstance.uploadArtifact).toHaveBeenCalledWith(
      'dependency-review-summary',
      ['summary.md'],
      '.',
      {retentionDays: 1}
    )
    expect(result).toContain('# Dependency Review Summary')
    expect(result).toContain('dependency-review-summary')
    expect(result).toContain('actions/runs/12345')
  })
  test('returns original summary and logs a warning when artifact handling fails', async () => {
    const warningMock = core.warning as jest.Mock
    warningMock.mockClear()
    const largeSummary = 'b'.repeat(1024 * 1024 + 1)
    DefaultArtifactClientMock.mockImplementation(() => ({
      uploadArtifact: jest.fn(async () => {
        throw new Error('upload failed')
      })
    }))
    const result = await handleLargeSummary(largeSummary)
    expect(result).toBe(largeSummary)
    expect(warningMock).toHaveBeenCalledWith(
      expect.stringContaining('Failed to handle large summary')
    )
  })
 })
@@ -1,7 +1,7 @@
-import {expect, test, describe} from '@jest/globals'
+import {expect, test} from '@jest/globals'
 import * as spdx from '../src/spdx'
-describe('satisfiesAny', () => {
+test('satisfiesAny', () => {
  const units = [
    {
      candidate: 'MIT',
@@ -55,28 +55,21 @@ describe('satisfiesAny', () => {
      candidate: 'MIT OR ISC',
      licenses: ['MiT'],
      expected: false
    },
    {
      candidate: 'MIT AND OTHER',
      licenses: ['MIT'],
      expected: false
    },
    {
      candidate: 'MIT OR OTHER',
      licenses: ['MIT', 'LicenseRef-clearlydefined-OTHER'],
      expected: true
    }
  ]
  for (const unit of units) {
-    const got: boolean = spdx.satisfiesAny(unit.candidate, unit.licenses)
+    let got: boolean = spdx.satisfiesAny(unit.candidate, unit.licenses)
-    test(`should return ${unit.expected} for ("${unit.candidate}", "${unit.licenses}")`, () => {
+    if (got != unit.expected) {
-      expect(got).toBe(unit.expected)
+      console.log(
-    })
+        `failing unit test inputs: candidate(${unit.candidate}) licenses(${unit.licenses})`
      )
    }
    expect(got).toBe(unit.expected)
  }
 })
-describe('satisfiesAll', () => {
+test('satisfiesAll', () => {
  const units = [
    {
      candidate: 'MIT',
@@ -140,72 +133,65 @@ describe('satisfiesAll', () => {
      candidate: 'MIT OR ISC',
      licenses: ['MiT'],
      expected: false
    },
    {
      candidate: 'MIT AND OTHER',
      licenses: ['MIT'],
      expected: false
    },
    {
      candidate: 'MIT AND OTHER',
      licenses: ['MIT', 'LicenseRef-clearlydefined-OTHER'],
      expected: true
    }
  ]
  for (const unit of units) {
-    const got: boolean = spdx.satisfiesAll(unit.candidate, unit.licenses)
+    let got: boolean = spdx.satisfiesAll(unit.candidate, unit.licenses)
-    test(`should return ${unit.expected} for ("${unit.candidate}", "${unit.licenses}")`, () => {
+    if (got != unit.expected) {
-      expect(got).toBe(unit.expected)
+      console.log(
-    })
+        `failing unit test inputs: candidate(${unit.candidate}) licenses(${unit.licenses})`
      )
    }
    expect(got).toBe(unit.expected)
  }
 })
-describe('satisfies', () => {
+test('satisfies', () => {
  const units = [
    {
      candidate: 'MIT',
-      allowList: ['MIT'],
+      constraint: 'MIT',
      expected: true
    },
    {
      candidate: 'Apache-2.0',
-      allowList: ['MIT'],
+      constraint: 'MIT',
      expected: false
    },
    {
      candidate: 'MIT OR Apache-2.0',
-      allowList: ['MIT'],
+      constraint: 'MIT',
      expected: true
    },
    {
      candidate: 'MIT OR Apache-2.0',
-      allowList: ['Apache-2.0'],
+      constraint: 'Apache-2.0',
      expected: true
    },
    {
      candidate: 'MIT OR Apache-2.0',
-      allowList: ['BSD-3-Clause'],
+      constraint: 'BSD-3-Clause',
      expected: false
    },
    {
      candidate: 'MIT OR Apache-2.0',
-      allowList: ['Apache-2.0', 'BSD-3-Clause'],
+      constraint: 'Apache-2.0 OR BSD-3-Clause',
      expected: true
    },
    {
      candidate: 'MIT AND Apache-2.0',
-      allowList: ['MIT', 'Apache-2.0'],
+      constraint: 'MIT AND Apache-2.0',
      expected: true
    },
    {
      candidate: 'MIT OR Apache-2.0',
-      allowList: ['MIT', 'Apache-2.0'],
+      constraint: 'MIT AND Apache-2.0',
-      expected: true
+      expected: false
    },
    {
      candidate: 'ISC OR (MIT AND Apache-2.0)',
-      allowList: ['MIT', 'Apache-2.0'],
+      constraint: 'MIT AND Apache-2.0',
      expected: true
    },
@@ -213,45 +199,38 @@ describe('satisfies', () => {
    // or unknown licenses will return 'false'
    {
      candidate: 'MIT',
-      allowList: ['MiT'],
+      constraint: 'MiT',
      expected: false
    },
    {
      candidate: 'MIT AND (ISC OR',
-      allowList: ['MIT'],
+      constraint: 'MIT',
      expected: false
    },
    {
      candidate: 'MIT OR ISC OR Apache-2.0',
-      allowList: [],
+      constraint: '',
      expected: false
    },
    {
      candidate: '',
-      allowList: ['BSD-3-Clause', 'ISC', 'MIT'],
+      constraint: '(BSD-3-Clause AND ISC) OR MIT',
      expected: false
    },
    {
      candidate: 'MIT OR OTHER',
      allowList: ['MIT', 'LicenseRef-clearlydefined-OTHER'],
      expected: true
    },
    {
      candidate: '(Apache-2.0 AND OTHER) OR (MIT AND OTHER)',
      allowList: ['Apache-2.0', 'LicenseRef-clearlydefined-OTHER'],
      expected: true
    }
  ]
  for (const unit of units) {
-    const got: boolean = spdx.satisfies(unit.candidate, unit.allowList)
+    let got: boolean = spdx.satisfies(unit.candidate, unit.constraint)
-    test(`should return ${unit.expected} for ("${unit.candidate}", "${unit.allowList}")`, () => {
+    if (got != unit.expected) {
-      expect(got).toBe(unit.expected)
+      console.log(
-    })
+        `failing unit test inputs: candidateExpr(${unit.candidate}) constraintExpr(${unit.constraint})`
      )
    }
    expect(got).toBe(unit.expected)
  }
 })
-describe('isValid', () => {
+test('isValid', () => {
  const units = [
    {
      candidate: 'MIT',
@@ -276,51 +255,13 @@ describe('isValid', () => {
    {
      candidate: '',
      expected: false
    },
    {
      candidate: 'MIT AND OTHER',
      expected: true
    }
  ]
  for (const unit of units) {
-    const got: boolean = spdx.isValid(unit.candidate)
+    let got: boolean = spdx.isValid(unit.candidate)
-    test(`should return ${unit.expected} for ("${unit.candidate}")`, () => {
+    if (got != unit.expected) {
-      expect(got).toBe(unit.expected)
+      console.log(`failing unit test inputs: candidateExpr(${unit.candidate})`)
    })
  }
 })
 describe('cleanInvalidSPDX', () => {
  const units = [
    {
      candidate: 'MIT',
      expected: 'MIT'
    },
    {
      candidate: 'OTHER',
      expected: 'LicenseRef-clearlydefined-OTHER'
    },
    {
      candidate: 'LicenseRef-clearlydefined-OTHER',
      expected: 'LicenseRef-clearlydefined-OTHER'
    },
    {
      candidate: 'OTHER AND MIT',
      expected: 'LicenseRef-clearlydefined-OTHER AND MIT'
    },
    {
      candidate: 'MIT AND OTHER',
      expected: 'MIT AND LicenseRef-clearlydefined-OTHER'
    },
    {
      candidate: 'MIT AND SomethingElse-OTHER',
      expected: 'MIT AND SomethingElse-OTHER'
    }
-  ]
+    expect(got).toBe(unit.expected)
  for (const unit of units) {
    const got: string = spdx.cleanInvalidSPDX(unit.candidate)
    test(`should return ${unit.expected} for ("${unit.candidate}")`, () => {
      expect(got).toBe(unit.expected)
    })
  }
 })
@@ -1,5 +1,5 @@
 import {expect, jest, test} from '@jest/globals'
-import {Changes, ConfigurationOptions, Scorecard} from '../src/schemas'
+import {Change, 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'
@@ -109,38 +109,46 @@ test('prints headline as h1', () => {
  expect(text).toContain('<h1>Dependency Review</h1>')
 })
-test('does not add deprecation warning for deny-licenses option if not set', () => {
+test('returns minimal summary in case the core.summary is too large for a PR comment', () => {
-  summary.addSummaryToSummary(
+  let changes: Changes = [
-    emptyChanges,
+    createTestChange({name: 'lodash', version: '1.2.3'}),
    createTestChange({name: 'colors', version: '2.3.4'}),
    createTestChange({name: '@foo/bar', version: '*'})
  ]
  let minSummary: string = summary.addSummaryToSummary(
    changes,
    emptyInvalidLicenseChanges,
    emptyChanges,
    scorecard,
    defaultConfig
  )
  // side effect DR report into core.summary as happens in main.ts
  summary.addScannedDependencies(changes)
  const text = core.summary.stringify()
-  expect(text).not.toContain('deny-licenses')
+  expect(text).toContain('<h1>Dependency Review</h1>')
-})
+  expect(minSummary).toContain('# Dependency Review')
-test('adds deprecation warning for deny-licenses option if set', () => {
+  expect(text).toContain('❌ 3 vulnerable package(s)')
-  const config = {...defaultConfig, deny_licenses: ['MIT']}
+  expect(text).not.toContain('* ❌ 3 vulnerable package(s)')
  expect(text).toContain('lodash')
  expect(text).toContain('colors')
  expect(text).toContain('@foo/bar')
-  summary.addSummaryToSummary(
+  expect(minSummary).toContain('* ❌ 3 vulnerable package(s)')
-    emptyChanges,
+  expect(minSummary).not.toContain('lodash')
-    emptyInvalidLicenseChanges,
+  expect(minSummary).not.toContain('colors')
-    emptyChanges,
+  expect(minSummary).not.toContain('@foo/bar')
    scorecard,
    config
  )
  const text = core.summary.stringify()
-  expect(text).toContain('deny-licenses')
+  expect(text.length).toBeGreaterThan(minSummary.length)
 })
 test('returns minimal summary formatted for posting as a PR comment', () => {
  const OLD_ENV = process.env
-  const changes: Changes = [
+  let changes: Changes = [
    createTestChange({name: 'lodash', version: '1.2.3'}),
    createTestChange({name: 'colors', version: '2.3.4'}),
    createTestChange({name: '@foo/bar', version: '*'})
@@ -150,7 +158,7 @@ test('returns minimal summary formatted for posting as a PR comment', () => {
  process.env.GITHUB_REPOSITORY = 'owner/repo'
  process.env.GITHUB_RUN_ID = 'abc-123-xyz'
-  const minSummary: string = summary.addSummaryToSummary(
+  let minSummary: string = summary.addSummaryToSummary(
    changes,
    emptyInvalidLicenseChanges,
    emptyChanges,
@@ -224,10 +232,14 @@ test('groups dependencies with empty manifest paths together', () => {
    emptyScorecard,
    defaultConfig
  )
-  summary.addScannedFiles(changesWithEmptyManifests)
+  summary.addScannedDependencies(changesWithEmptyManifests)
  const text = core.summary.stringify()
-  expect(text).toContain('Unnamed Manifest')
+
-  expect(text).toContain('python/dist-info/METADATA')
+  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', () => {
@@ -464,9 +476,7 @@ test('addLicensesToSummary() - includes list of configured allowed licenses', ()
  summary.addLicensesToSummary(licenseIssues, config)
  const text = core.summary.stringify()
-  expect(text).toContain(
+  expect(text).toContain('<strong>Allowed Licenses</strong>: MIT, Apache-2.0')
    '<details><summary><strong>Allowed Licenses</strong>:</summary> MIT, Apache-2.0</details>'
  )
 })
 test('addLicensesToSummary() - includes configured denied license', () => {
@@ -478,33 +488,11 @@ test('addLicensesToSummary() - includes configured denied license', () => {
  const config: ConfigurationOptions = {
    ...defaultConfig,
-    deny_licenses: ['MIT', 'Apache-2.0']
+    deny_licenses: ['MIT']
  }
  summary.addLicensesToSummary(licenseIssues, config)
  const text = core.summary.stringify()
-  expect(text).toContain(
+  expect(text).toContain('<strong>Denied Licenses</strong>: MIT')
    '<details><summary><strong>Denied Licenses</strong>:</summary> MIT, Apache-2.0</details>'
  )
 })
 test('addLicensesToSummary() - includes allowed dependency licences', () => {
  const licenseIssues = {
    forbidden: [createTestChange()],
    unresolved: [],
    unlicensed: []
  }
  const config: ConfigurationOptions = {
    ...defaultConfig,
    allow_dependencies_licenses: ['MIT', 'Apache-2.0']
  }
  summary.addLicensesToSummary(licenseIssues, config)
  const text = core.summary.stringify()
  expect(text).toContain(
    '<details><summary><strong>Excluded from license check</strong>:</summary> MIT, Apache-2.0</details>'
  )
 })
@@ -1,4 +1,4 @@
-# Examples of how to use the Dependency Review Action
+# Examples on how to use the Dependency Review Action
 ## Basic Usage
@@ -89,7 +89,7 @@ The following example will use a configuration file from an external public GitH
 Let's say that the configuration file is located in `github/octorepo/dependency-review-config.yml@main`
-The Dependency Review Action workflow file will then look like this:
+The Dependancy Review Action workflow file will then look like this:
 ```yaml
 name: 'Dependency Review'
@@ -116,7 +116,7 @@ The following example will use a configuration file from an external private Gti
 Let's say that the configuration file is located in `github/octorepo-private/dependency-review-config.yml@main`
-The Dependency Review Action workflow file will then look like this:
+The Dependancy Review Action workflow file will then look like this:
 ```yaml
 name: 'Dependency Review'
@@ -1,6 +1,6 @@
 {
  "name": "dependency-review-action",
-  "version": "4.8.0",
+  "version": "4.3.3",
  "private": true,
  "description": "A GitHub Action for Dependency Review",
  "main": "lib/main.js",
@@ -25,42 +25,37 @@
  "author": "GitHub",
  "license": "MIT",
  "dependencies": {
-    "@actions/artifact": "^2.3.2",
+    "@actions/core": "^1.10.1",
-    "@actions/core": "^1.11.1",
+    "@actions/github": "^6.0.0",
-    "@actions/github": "^6.0.1",
+    "@octokit/plugin-retry": "^6.0.1",
-    "@octokit/plugin-retry": "^6.1.0",
+    "@octokit/request-error": "^5.0.1",
    "@octokit/request-error": "^5.1.1",
    "@octokit/types": "12.5.0",
    "@onebeyond/spdx-license-satisfies": "^1.0.1",
    "ansi-styles": "^6.2.1",
-    "got": "^14.4.7",
+    "got": "^14.2.0",
    "jest": "^29.7.0",
    "octokit": "^3.1.2",
    "spdx-expression-parse": "^3.0.1",
-    "spdx-satisfies": "^6.0.0",
+    "spdx-satisfies": "^5.0.1",
-    "ts-jest": "^29.4.1",
+    "ts-jest": "^29.1.2",
-    "yaml": "^2.8.1",
+    "yaml": "^2.3.4",
-    "zod": "^3.24.1"
+    "zod": "^3.22.3"
  },
  "devDependencies": {
    "@types/jest": "^29.5.12",
    "@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.3",
+    "@vercel/ncc": "^0.38.0",
-    "esbuild-register": "^3.6.0",
+    "esbuild-register": "^3.5.0",
    "eslint": "^8.57.0",
    "eslint-plugin-github": "^4.10.2",
-    "eslint-plugin-jest": "^28.8.3",
+    "eslint-plugin-jest": "^27.9.0",
-    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-prettier": "^5.1.3",
    "js-yaml": "^4.1.0",
-    "nodemon": "^3.1.10",
+    "nodemon": "^3.1.0",
-    "prettier": "3.6.2",
+    "prettier": "3.2.5",
-    "typescript": "^5.9.2"
+    "typescript": "^5.4.5"
  },
  "overrides": {
    "cross-spawn": ">=7.0.5",
    "@octokit/[email protected]": "5.1.1"
  }
 }
@@ -143,7 +143,7 @@ async function createSummary(
    ...licenseIssues.unlicensed
  ]
-  summary.addScannedFiles(allChanges)
+  summary.addScannedDependencies(allChanges)
  const text = core.summary.stringify()
  await fs.promises.writeFile(path.resolve(tmpDir, fileName), text, {
@@ -1,8 +1,87 @@
 #!/usr/bin/env ruby
 require 'json'
 require 'tempfile'
 require 'open3'
 require 'bundler/inline'
 require 'optparse'
-# Load the scan_pr library
+gemfile do
-require_relative 'scan_pr_lib'
+  source 'https://rubygems.org'
  gem 'octokit'
 end
-# Create and run the scanner
+config_file = nil
-scanner = ScanPr.new
+github_token = ENV["GITHUB_TOKEN"]
-scanner.run(ARGV)
+
 if !github_token || github_token.empty?
  puts "Please set the GITHUB_TOKEN environment variable"
  exit -1
 end
 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 op
  exit -1
 end
 repo_nwo = arg[:repo_nwo]
 pr_number = arg[:pr_number]
 octo = Octokit::Client.new(access_token: github_token)
 pr = octo.pull_request(repo_nwo, pr_number)
 event_file = Tempfile.new
 event_file.write("{ \"pull_request\": #{pr.to_h.to_json}}")
 event_file.close
 action_inputs = {
  "repo-token": github_token,
  "config-file": config_file
 }
 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.gsub(github_token, "<REDACTED>")
  end
 end
@@ -1,128 +0,0 @@
 require 'json'
 require 'tempfile'
 require 'open3'
 require 'bundler/inline'
 require 'optparse'
 gemfile do
  source 'https://rubygems.org'
  gem 'octokit'
 end
 class ScanPr
  def initialize
    @config_file = nil
    @github_token = ENV["GITHUB_TOKEN"]
    validate_token
  end
  def run(args)
    parse_options(args)
    repo_nwo, pr_number = extract_repo_and_pr(args)
    pr = fetch_pull_request(repo_nwo, pr_number)
    event_file = create_event_file(pr)
    execute_dependency_review(repo_nwo, event_file)
  ensure
    event_file&.unlink
  end
  private
  def validate_token
    if !@github_token || @github_token.empty?
      puts "Please set the GITHUB_TOKEN environment variable"
      exit -1
    end
  end
  def parse_options(args)
    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!(args)
    @option_parser = op
  end
  def extract_repo_and_pr(args)
    # make sure we have a NWO somewhere in the parameters
    arg = /(?<repo_nwo>[\w\-]+\/[\w\-]+)\/pull\/(?<pr_number>\d+)/.match(args.join(" "))
    if arg.nil?
      puts @option_parser
      exit -1
    end
    [arg[:repo_nwo], arg[:pr_number]]
  end
  def fetch_pull_request(repo_nwo, pr_number)
    octo = Octokit::Client.new(access_token: @github_token)
    octo.pull_request(repo_nwo, pr_number)
  end
  def create_event_file(pr)
    event_file = Tempfile.new
    event_file.write("{ \"pull_request\": #{pr.to_h.to_json}}")
    event_file.close
    event_file
  end
  def execute_dependency_review(repo_nwo, event_file)
    action_inputs = {
      "repo-token": @github_token,
      "config-file": @config_file
    }
    dev_cmd_env = {
      "GITHUB_REPOSITORY" => repo_nwo,
      "GITHUB_EVENT_NAME" => "pull_request",
      "GITHUB_EVENT_PATH" => event_file.path,
      "GITHUB_STEP_SUMMARY" => "/dev/null"
    }
    # Merge action inputs into environment, formatting keys as INPUT_...
    action_inputs_env = action_inputs.each_with_object({}) do |(name, value), h|
      h["INPUT_#{name.to_s.upcase}"] = value unless value.nil?
    end
    env = dev_cmd_env.merge(action_inputs_env)
    dev_cmd = [
      "./node_modules/.bin/nodemon",
      "--exec",
      "node",
      "-r",
      "esbuild-register",
      "src/main.ts"
    ]
    Open3.popen2e(env, *dev_cmd) do |stdin, out|
      while line = out.gets
        puts line.gsub(@github_token, "<REDACTED>")
      end
    end
  end
 end
@@ -17,13 +17,13 @@ const COMMENT_MARKER = '<!-- dependency-review-pr-comment-marker -->'
 export async function commentPr(
  commentContent: string,
-  config: ConfigurationOptions,
+  config: ConfigurationOptions
  issueFound: boolean
 ): Promise<void> {
  if (
    !(
      config.comment_summary_in_pr === 'always' ||
-      (config.comment_summary_in_pr === 'on-failure' && issueFound)
+      (config.comment_summary_in_pr === 'on-failure' &&
        process.exitCode === core.ExitCode.Failure)
    )
  ) {
    return
@@ -9,17 +9,15 @@ export async function getDeniedChanges(
 ): Promise<Change[]> {
  const changesDenied: Change[] = []
  let hasDeniedPackage = false
  for (const change of changes) {
    if (change.change_type === 'removed') {
      continue
    }
    for (const denied of deniedPackages) {
      if (
        (!denied.version || change.version === denied.version) &&
        change.name === denied.name
      ) {
        changesDenied.push(change)
        hasDeniedPackage = true
      }
    }
@@ -32,10 +30,17 @@ export async function getDeniedChanges(
      }
      if (namespace && namespace === denied.namespace) {
        changesDenied.push(change)
        hasDeniedPackage = true
      }
    }
  }
  if (hasDeniedPackage) {
    core.setFailed('Dependency review detected denied packages.')
  } else {
    core.info('Dependency review did not detect any denied packages')
  }
  return changesDenied
 }
@@ -1,53 +1,40 @@
-import {
+import {PullRequestSchema, ConfigurationOptions} from './schemas'
  PullRequestSchema,
  ConfigurationOptions,
  MergeGroupSchema
 } from './schemas'
 export function getRefs(
  config: ConfigurationOptions,
-  context: {
+  context: {payload: {pull_request?: unknown}; eventName: string}
    payload: {pull_request?: unknown; merge_group?: 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 (!base_ref && !head_ref) {
+  if (
-    if (
+    context.eventName === 'pull_request' ||
-      context.eventName === 'pull_request' ||
+    context.eventName === 'pull_request_target'
-      context.eventName === 'pull_request_target'
+  ) {
-    ) {
+    const pull_request = PullRequestSchema.parse(context.payload.pull_request)
-      const pull_request = PullRequestSchema.parse(context.payload.pull_request)
+    base_ref = base_ref || pull_request.base.sha
-      base_ref = base_ref || pull_request.base.sha
+    head_ref = head_ref || pull_request.head.sha
      head_ref = head_ref || pull_request.head.sha
    } else if (context.eventName === 'merge_group') {
      const merge_group = MergeGroupSchema.parse(context.payload.merge_group)
      base_ref = base_ref || merge_group.base_sha
      head_ref = head_ref || merge_group.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`/`merge_group` workflow.'
+        '`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`/`merge_group` workflow.'
+        '`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`/`merge_group` workflow.'
+        'or by running a `pull_request`/`pull_request_target` workflow.'
    )
  }
@@ -1,6 +1,6 @@
 import {Change, Changes} from './schemas'
 import {octokitClient} from './utils'
-import {parsePURL, PackageURL} from './purl'
+import {parsePURL} from './purl'
 import * as spdx from './spdx'
 /**
@@ -29,24 +29,41 @@ export async function getInvalidLicenseChanges(
    licenseExclusions?: string[]
  }
 ): Promise<InvalidLicenseChanges> {
-  const deny = licenses.deny
+  const {allow, deny} = licenses
  let allow = licenses.allow
  // Filter out elements of the allow list that include AND
  // or OR because the list should be simple license IDs and
  // not expressions.
  allow = allow?.filter(license => {
    return !license.includes(' AND ') && !license.includes(' OR ')
  })
  const licenseExclusions = licenses.licenseExclusions?.map(
    (pkgUrl: string) => {
      return parsePURL(pkgUrl)
    }
  )
-  const groupedChanges = await groupChanges(changes, licenseExclusions)
+  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 = parsePURL(encodeURI(change.package_url))
    // We want to find if the licenseExclusion 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 = {
@@ -71,7 +88,7 @@ export async function getInvalidLicenseChanges(
      try {
        if (allow !== undefined) {
          if (spdx.isValid(license)) {
-            const found = spdx.satisfies(license, allow)
+            const found = spdx.satisfiesAny(license, allow)
            validityCache.set(license, found)
          } else {
            invalidLicenseChanges.unresolved.push(change)
@@ -155,48 +172,16 @@ const truncatedDGLicense = (license: string): boolean =>
  license.length === 255 && !spdx.isValid(license)
 async function groupChanges(
-  changes: Changes,
+  changes: Changes
  licenseExclusions: PackageURL[] | null = null
 ): Promise<Record<string, Changes>> {
  const result: Record<string, Changes> = {
    licensed: [],
    unlicensed: []
  }
  let candidateChanges = changes
  // If a package is excluded from license checking, we don't bother trying to
  // fetch the license for it and we leave it off of the `licensed` and
  // `unlicensed` lists.
  if (licenseExclusions !== null && licenseExclusions !== undefined) {
    candidateChanges = candidateChanges.filter(change => {
      if (change.package_url.length === 0) {
        return true
      }
      const changeAsPackageURL = parsePURL(encodeURI(change.package_url))
      // We want to find if the licenseExclusion 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.findIndex(
          exclusion =>
            exclusion.type === changeAsPackageURL.type &&
            exclusion.namespace === changeAsPackageURL.namespace &&
            exclusion.name === changeAsPackageURL.name
        ) !== -1
      ) {
        return false
      } else {
        return true
      }
    })
  }
  const ghChanges = []
-  for (const change of candidateChanges) {
+  for (const change of changes) {
    if (change.change_type === 'removed') {
      continue
    }
@@ -24,8 +24,6 @@ import {getRefs} from './git-refs'
 import {groupDependenciesByManifest} from './utils'
 import {commentPr, MAX_COMMENT_LENGTH} from './comment-pr'
 import {getDeniedChanges} from './deny'
 import * as artifact from '@actions/artifact'
 import * as fs from 'fs'
 async function delay(ms: number): Promise<void> {
  return new Promise(resolve => setTimeout(resolve, ms))
@@ -63,41 +61,6 @@ async function getComparison(
  return comparison
 }
 export async function handleLargeSummary(
  summaryContent: string
 ): Promise<string> {
  const MAX_SUMMARY_SIZE = 1024 * 1024 // 1024k in bytes
  if (Buffer.byteLength(summaryContent, 'utf8') <= MAX_SUMMARY_SIZE) {
    return summaryContent
  }
  const artifactClient = new artifact.DefaultArtifactClient()
  const artifactName = 'dependency-review-summary'
  const files = ['summary.md']
  try {
    // Write the summary to a file
    await fs.promises.writeFile('summary.md', summaryContent)
    // Upload the artifact
    await artifactClient.uploadArtifact(artifactName, files, '.', {
      retentionDays: 1
    })
    // Return a minimal summary with a link to the artifact
    return `# Dependency Review Summary
 The full dependency review summary is too large to display here. Please download the artifact named "${artifactName}" to view the complete report.
 [View full job summary](${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID})`
  } catch (error) {
    core.warning(
      `Failed to handle large summary: ${error instanceof Error ? error.message : 'Unknown error'}`
    )
    return summaryContent
  }
 }
 async function run(): Promise<void> {
  try {
    const config = await readConfig()
@@ -162,9 +125,7 @@ async function run(): Promise<void> {
      config.deny_groups
    )
-    // generate informational scorecard entries for all added changes in the PR
+    const scorecard = await getScorecardLevels(filteredChanges)
    const scorecardChanges = getScorecardChanges(changes)
    const scorecard = await getScorecardLevels(scorecardChanges)
    const minSummary = summary.addSummaryToSummary(
      vulnerableChanges,
@@ -178,16 +139,10 @@ async function run(): Promise<void> {
      summary.addSnapshotWarnings(config, snapshot_warnings)
    }
    let issueFound = false
    if (config.vulnerability_check) {
      core.setOutput('vulnerable-changes', JSON.stringify(vulnerableChanges))
      summary.addChangeVulnerabilitiesToSummary(vulnerableChanges, minSeverity)
-      issueFound ||= await printVulnerabilitiesBlock(
+      printVulnerabilitiesBlock(vulnerableChanges, minSeverity, warnOnly)
        vulnerableChanges,
        minSeverity,
        warnOnly
      )
    }
    if (config.license_check) {
      core.setOutput(
@@ -195,12 +150,12 @@ async function run(): Promise<void> {
        JSON.stringify(invalidLicenseChanges)
      )
      summary.addLicensesToSummary(invalidLicenseChanges, config)
-      issueFound ||= await printLicensesBlock(invalidLicenseChanges, warnOnly)
+      printLicensesBlock(invalidLicenseChanges, warnOnly)
    }
    if (config.deny_packages || config.deny_groups) {
      core.setOutput('denied-changes', JSON.stringify(deniedChanges))
      summary.addDeniedToSummary(deniedChanges)
-      issueFound ||= await printDeniedDependencies(deniedChanges, config)
+      printDeniedDependencies(deniedChanges, config)
    }
    if (config.show_openssf_scorecard) {
      summary.addScorecardToSummary(scorecard, config)
@@ -209,16 +164,13 @@ async function run(): Promise<void> {
    }
    core.setOutput('dependency-changes', JSON.stringify(changes))
-    summary.addScannedFiles(changes)
+    summary.addScannedDependencies(changes)
    printScannedDependencies(changes)
    // include full summary in output; Actions will truncate if oversized
    let rendered = core.summary.stringify()
    core.setOutput('comment-content', rendered)
    // Handle large summaries by uploading as artifact
    rendered = await handleLargeSummary(rendered)
    // if the summary is oversized, replace with minimal version
    if (rendered.length >= MAX_COMMENT_LENGTH) {
      core.debug(
@@ -228,7 +180,7 @@ async function run(): Promise<void> {
    }
    // update the PR comment if needed with the right-sized summary
-    await commentPr(rendered, config, issueFound)
+    await commentPr(rendered, config)
  } catch (error) {
    if (error instanceof RequestError && error.status === 404) {
      core.setFailed(
@@ -236,7 +188,7 @@ async function run(): Promise<void> {
      )
    } 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 ${github.context.serverUrl}/${github.context.repo.owner}/${github.context.repo.repo}/settings/security_analysis`
+        `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) {
@@ -250,16 +202,18 @@ async function run(): Promise<void> {
  }
 }
-async function printVulnerabilitiesBlock(
+function printVulnerabilitiesBlock(
  addedChanges: Changes,
  minSeverity: Severity,
  warnOnly: boolean
-): Promise<boolean> {
+): void {
-  return core.group('Vulnerabilities', async () => {
+  let vulFound = false
-    let vulFound = false
+  core.group('Vulnerabilities', async () => {
-
+    if (addedChanges.length > 0) {
-    for (const change of addedChanges) {
+      for (const change of addedChanges) {
-      vulFound ||= printChangeVulnerabilities(change)
+        printChangeVulnerabilities(change)
      }
      vulFound = true
    }
    if (vulFound) {
@@ -274,12 +228,10 @@ async function printVulnerabilitiesBlock(
        `Dependency review did not detect any vulnerable packages with severity level "${minSeverity}" or higher.`
      )
    }
    return vulFound
  })
 }
-function printChangeVulnerabilities(change: Change): boolean {
+function printChangeVulnerabilities(change: Change): void {
  for (const vuln of change.vulnerabilities) {
    core.info(
      `${styles.bold.open}${change.manifest} » ${change.name}@${
@@ -290,18 +242,14 @@ function printChangeVulnerabilities(change: Change): boolean {
    )
    core.info(`  ↪ ${vuln.advisory_url}`)
  }
  return change.vulnerabilities.length > 0
 }
-async function printLicensesBlock(
+function printLicensesBlock(
  invalidLicenseChanges: Record<string, Changes>,
  warnOnly: boolean
-): Promise<boolean> {
+): void {
-  return core.group('Licenses', async () => {
+  core.group('Licenses', async () => {
    let issueFound = false
    if (invalidLicenseChanges.forbidden.length > 0) {
      issueFound = true
      core.info('\nThe following dependencies have incompatible licenses:')
      printLicensesError(invalidLicenseChanges.forbidden)
      const msg = 'Dependency review detected incompatible licenses.'
@@ -312,7 +260,6 @@ async function printLicensesBlock(
      }
    }
    if (invalidLicenseChanges.unresolved.length > 0) {
      issueFound = true
      core.warning(
        '\nThe validity of the licenses of the dependencies below could not be determined. Ensure that they are valid SPDX licenses:'
      )
@@ -322,8 +269,6 @@ async function printLicensesBlock(
      )
    }
    printNullLicenses(invalidLicenseChanges.unlicensed)
    return issueFound
  })
 }
@@ -423,13 +368,11 @@ function printScannedDependencies(changes: Changes): void {
  })
 }
-async function printDeniedDependencies(
+function printDeniedDependencies(
-  changes: Changes,
+  changes: Change[],
  config: ConfigurationOptions
-): Promise<boolean> {
+): void {
-  return core.group('Denied', async () => {
+  core.group('Denied', async () => {
    let issueFound = false
    for (const denied of config.deny_packages) {
      core.info(`Config: ${denied}`)
    }
@@ -438,29 +381,9 @@ async function printDeniedDependencies(
      core.info(`Change: ${change.name}@${change.version} is denied`)
      core.info(`Change: ${change.package_url} is denied`)
    }
    if (changes.length > 0) {
      issueFound = true
      core.setFailed('Dependency review detected denied packages.')
    } else {
      core.info('Dependency review did not detect any denied packages')
    }
    return issueFound
  })
 }
 function getScorecardChanges(changes: Changes): Changes {
  const out: Changes = []
  for (const change of changes) {
    if (change.change_type === 'added') {
      out.push(change)
    }
  }
  return out
 }
 async function createScorecardWarnings(
  scorecards: Scorecard,
  config: ConfigurationOptions
@@ -91,11 +91,6 @@ export const PullRequestSchema = z.object({
  head: z.object({sha: z.string()})
 })
 export const MergeGroupSchema = z.object({
  base_sha: z.string(),
  head_sha: z.string()
 })
 export const ConfigurationOptionsSchema = z
  .object({
    fail_on_severity: SeveritySchema,
@@ -1,4 +0,0 @@
 declare module 'spdx-satisfies' {
  function spdxSatisfies(candidate: string, allowList: string[]): boolean
  export = spdxSatisfies
 }
@@ -1,5 +1,4 @@
 import * as spdxlib from '@onebeyond/spdx-license-satisfies'
 import spdxSatisfies from 'spdx-satisfies'
 import parse from 'spdx-expression-parse'
 /*
@@ -11,10 +10,12 @@ import parse from 'spdx-expression-parse'
 // accepts a pair of well-formed SPDX expressions. the
 // candidate is tested against the constraint
-export function satisfies(candidateExpr: string, allowList: string[]): boolean {
+export function satisfies(
-  candidateExpr = cleanInvalidSPDX(candidateExpr)
+  candidateExpr: string,
  constraintExpr: string
 ): boolean {
  try {
-    return spdxSatisfies(candidateExpr, allowList)
+    return spdxlib.satisfies(candidateExpr, constraintExpr)
  } catch (_) {
    return false
  }
@@ -25,7 +26,6 @@ export function satisfiesAny(
  candidateExpr: string,
  licenses: string[]
 ): boolean {
  candidateExpr = cleanInvalidSPDX(candidateExpr)
  try {
    return spdxlib.satisfiesAny(candidateExpr, licenses)
  } catch (_) {
@@ -38,7 +38,6 @@ export function satisfiesAll(
  candidateExpr: string,
  licenses: string[]
 ): boolean {
  candidateExpr = cleanInvalidSPDX(candidateExpr)
  try {
    return spdxlib.satisfiesAll(candidateExpr, licenses)
  } catch (_) {
@@ -48,7 +47,6 @@ export function satisfiesAll(
 // accepts any SPDX expression
 export function isValid(spdxExpr: string): boolean {
  spdxExpr = cleanInvalidSPDX(spdxExpr)
  try {
    parse(spdxExpr)
    return true
@@ -56,11 +54,3 @@ export function isValid(spdxExpr: string): boolean {
    return false
  }
 }
 const replaceOtherRegex = /(?<![\w-])OTHER(?![\w-])/g
 // adjusts license expressions to not include the invalid `OTHER`
 // which ClearlyDefined adds to license strings
 export function cleanInvalidSPDX(spdxExpr: string): string {
  return spdxExpr.replace(replaceOtherRegex, 'LicenseRef-clearlydefined-OTHER')
 }
@@ -1,7 +1,7 @@
 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 {Change, Changes, ConfigurationOptions, Scorecard} from './schemas'
 import {groupDependenciesByManifest, getManifestsSet, renderUrl} from './utils'
 const icons = {
@@ -10,8 +10,6 @@ const icons = {
  warning: '⚠️'
 }
 const MAX_SCANNED_FILES_BYTES = 1048576
 // generates the DR report summmary and caches it to the Action's core.summary.
 // returns the DR summary string, ready to be posted as a PR comment if the
 // final DR report is too large
@@ -22,10 +20,6 @@ export function addSummaryToSummary(
  scorecard: Scorecard,
  config: ConfigurationOptions
 ): string {
  if (config.deny_licenses && config.deny_licenses.length > 0) {
    addDenyListsDeprecationWarningToSummary()
  }
  const out: string[] = []
  const scorecardWarnings = countScorecardWarnings(scorecard, config)
@@ -110,13 +104,6 @@ export function addSummaryToSummary(
  return out.join('\n')
 }
 function addDenyListsDeprecationWarningToSummary(): void {
  core.summary.addRaw(
    `${icons.warning} <strong>Deprecation Warning</strong>: The <em>deny-licenses</em> option is deprecated for possible removal in the next major release. For more information, see actions/dependency-review-action/issues/938.`,
    true
  )
 }
 function countScorecardWarnings(
  scorecard: Scorecard,
  config: ConfigurationOptions
@@ -206,17 +193,19 @@ export function addLicensesToSummary(
  if (config.allow_licenses && config.allow_licenses.length > 0) {
    core.summary.addQuote(
-      `<details><summary><strong>Allowed Licenses</strong>:</summary> ${config.allow_licenses.join(', ')}</details>`
+      `<strong>Allowed Licenses</strong>: ${config.allow_licenses.join(', ')}`
    )
  }
  if (config.deny_licenses && config.deny_licenses.length > 0) {
    core.summary.addQuote(
-      `<details><summary><strong>Denied Licenses</strong>:</summary> ${config.deny_licenses.join(', ')}</details>`
+      `<strong>Denied Licenses</strong>: ${config.deny_licenses.join(', ')}`
    )
  }
  if (config.allow_dependencies_licenses) {
    core.summary.addQuote(
-      `<details><summary><strong>Excluded from license check</strong>:</summary> ${config.allow_dependencies_licenses.join(', ')}</details>`
+      `<strong>Excluded from license check</strong>: ${config.allow_dependencies_licenses.join(
        ', '
      )}`
    )
  }
@@ -274,37 +263,20 @@ function formatLicense(license: string | null): string {
  return license
 }
-export function addScannedFiles(changes: Changes): void {
+export function addScannedDependencies(changes: Changes): void {
-  const manifests = Array.from(
+  const dependencies = groupDependenciesByManifest(changes)
-    groupDependenciesByManifest(changes).keys()
+  const manifests = dependencies.keys()
  ).sort()
-  let sf_size = 0
+  const summary = core.summary.addHeading('Scanned Manifest Files', 2)
  let trunc_at = -1
-  for (const [index, entry] of manifests.entries()) {
+  for (const manifest of manifests) {
-    if (sf_size + entry.length >= MAX_SCANNED_FILES_BYTES) {
+    const deps = dependencies.get(manifest)
-      trunc_at = index
+    if (deps) {
-      break
+      const dependencyNames = deps.map(
        dependency => `<li>${dependency.name}@${dependency.version}</li>`
      )
      summary.addDetails(manifest, `<ul>${dependencyNames.join('')}</ul>`)
    }
    sf_size += entry.length
  }
  if (trunc_at >= 0) {
    // truncate the manifests list if it will overflow the summary output
    manifests.slice(0, trunc_at)
    // if there's room between cutoff size and list size, add a warning
    const size_diff = MAX_SCANNED_FILES_BYTES - sf_size
    if (size_diff < 12) {
      manifests.push('(truncated)')
    }
  }
  const summary = core.summary.addHeading('Scanned Files', 2)
  if (manifests.length === 0) {
    summary.addRaw('None')
  } else {
    summary.addList(manifests)
  }
 }
@@ -330,9 +302,6 @@ export function addScorecardToSummary(
  scorecard: Scorecard,
  config: ConfigurationOptions
 ): void {
  if (scorecard.dependencies.length === 0) {
    return
  }
  core.summary.addHeading('OpenSSF Scorecard', 2)
  if (scorecard.dependencies.length > 10) {
    core.summary.addRaw(`<details><summary>Scorecard details</summary>`, true)
@@ -13,4 +13,6 @@ declare module '@onebeyond/spdx-license-satisfies' {
    candidateExpr: string,
    licenses: string[]
  ): boolean
  export function isValid(candidateExpr: string): boolean
 }
Author	SHA1	Message	Date
Eli Reisman	310ae5f6ae	npm run package	2024-06-06 14:34:59 -07:00
Eli Reisman	4fabda986c	more SPDX unit tests to illustrate matching behavior	2024-06-06 14:34:55 -07:00
Eli Reisman	dfbe08e4d2	update licenses pkg and tests	2024-06-05 23:38:18 -07:00
Eli Reisman	3fc792b939	complete test suite conversions; simplify fn name	2024-06-05 23:38:18 -07:00
Eli Reisman	748dfadbc3	register spdx lib as ES Module, start converting call sites to use new spdx pkg - TODO: update tests	2024-06-05 23:38:18 -07:00
Eli Reisman	a97084db22	move jest to dev dependencies	2024-06-05 23:38:14 -07:00
Eli Reisman	e7ebeffdf9	add @onebeyond/spdx-license-satisfies to DR Action project	2024-06-05 16:43:46 -07:00