Skip to content

Latest commit

 

History

History
289 lines (209 loc) · 9.36 KB

README.md

File metadata and controls

289 lines (209 loc) · 9.36 KB
Raw

dependency-review-action

This action scans your pull requests for dependency changes, and will raise an error if any vulnerabilities or invalid licenses are being introduced. The action is supported by an API endpoint that diffs the dependencies between any two revisions.

The action is available for all public repositories, as well as private repositories that have GitHub Advanced Security licensed.

You can see the results on the job logs

Screen Shot 2022-03-31 at 1 10 51 PM

or on the job summary

Installation

Please keep in mind that you need a GitHub Advanced Security license if you're running this action on private repositories.

  1. Add a new YAML workflow to your .github/workflows folder:
name: 'Dependency Review'
on: [pull_request]

permissions:
  contents: read

jobs:
  dependency-review:
    runs-on: ubuntu-latest
    steps:
      - name: 'Checkout Repository'
        uses: actions/checkout@v3
      - name: 'Dependency Review'
        uses: actions/dependency-review-action@v2

GitHub Enterprise Server

This action is available in Enterprise Server starting with version 3.6. Make sure GitHub Advanced Security and GitHub Connect are enabled.

You can use the same workflow as above, replacing the runs-on value with the label of any of your runners (the default label is self-hosted):

# ...

jobs:
  dependency-review:
    runs-on: self-hosted
    steps:
      - name: 'Checkout Repository'
        uses: actions/checkout@v3
      - name: 'Dependency Review'
        uses: actions/dependency-review-action@v2

Configuration

Configure this action by either using an external configuration file, or by inlining these options in your workflow file.

Options

config-file

A string representing the path to an external configuraton file. By default external configuration files are not used.

Possible values: A string representing the absolute path to the configuration file.

Example: config-file: ./.github/dependency-review-config.yml.

fail-on-severity

Configure the severity level for alerting. See "Vulnerability Severity".

Possible values: critical, high, moderate, low.

Example: fail-on-severity: moderate.

fail-on-scopes

A list of strings representing the build environments you want to support. The default value is development, runtime.

Possible values: development, runtime, unknown

Inline example: fail-on-scopes: development, runtime

YAML example:

# this prevents scanning development dependencies
fail-on-scopes:
  - runtime

allow-licenses

Only allow the licenses in this list. See "Licenses".

Possible values: Any spdx_id value(s) from https://docs.github.com/en/rest/licenses.

Inline example: allow-licenses: BSD-3-Clause, MIT

YAML example:

allow-licenses:
  - BSD-3-Clause
  - MIT

deny-licenses

Add a custom list of licenses you want to block. See "Licenses".

Possible values: Any spdx_id value(s) from https://docs.github.com/en/rest/licenses.

Inline example: deny-licenses: LGPL-2.0, BSD-2-Clause

YAML example:

deny-licenses:
  - LGPL-2.0
  - BSD-2-Clause

base-ref/head-ref

Provide custom git references for the git base/head when performing the comparison. If you are using pull requests, or pull_request_target events you do not need to worry about setting this. The values need to be specified for all other event types.

Possible values: Any valid git ref(s) in your project.

Example:

base-ref: 8bb8a58d6a4028b6c2e314d5caaf273f57644896
head-ref: 69af5638bf660cf218aad5709a4c100e42a2f37b

Configuration File

You can use an external configuration file to specify the settings for this Action.

Start by specifying that you will be using an external configuration file:

- name: Dependency Review
  uses: actions/dependency-review-action@v2
  with:
    config-file: "./.github/dependency-review-config.yml"

And then create the file in the path you just specified. All of these fields are optional:

fail-on-severity: "critical"
allow-licenses:
  - "GPL-3.0"
  - "BSD-3-Clause"
  - "MIT"

Inline Configuration

You can pass options to the Dependency Review Action using your workflow file. Here's an example of what the full file would look like:

name: 'Dependency Review'
on: [pull_request]
permissions:
  contents: read
jobs:
  dependency-review:
    runs-on: ubuntu-latest
    steps:
      - name: 'Checkout Repository'
        uses: actions/checkout@v3
      - name: Dependency Review
        uses: actions/dependency-review-action@v2
        with:
          fail-on-severity: moderate

          # Use comma-separated names to pass list arguments:
          deny-licenses: LGPL-2.0, BSD-2-Clause

Vulnerability Severity

By default the action will fail on any pull request that contains a vulnerable dependency, regardless of the severity level. You can override this behavior by using the fail-on-severity option, which will cause a failure on any pull requests that introduce vulnerabilities of the specified severity level or higher. The possible values are: critical, high, moderate, or low. The action defaults to low.

This example will only fail on pull requests with critical and high vulnerabilities:

- name: Dependency Review
  uses: actions/dependency-review-action@v2
  with:
    fail-on-severity: high

Dependency Scoping

By default the action will only fail on runtime dependencies that have vulnerabilities or unacceptable licenses, ignoring development dependencies. You can override this behavior with the fail-on-scopes option, which will allow you to list the specific dependency scopes you care about. The possible values are: unknown, runtime, and development. Note: Filtering by scope will not be supported on Enterprise Server just yet, as the REST API's introduction of scope will be released in an upcoming Enterprise Server version. We will treat all dependencies on Enterprise Server as having a runtime scope and thus will not be filtered away.

- name: Dependency Review
  uses: actions/dependency-review-action@v2
  with:
    fail-on-scopes: runtime, development

Licenses

You can set the action to fail on pull requests based on the licenses of the dependencies they introduce. With allow-licenses you can define the list of licenses your repository will accept. Alternatively, you can use deny-licenses to only forbid a subset of licenses. These options are not supported on Enterprise Server.

You can use the Licenses API to see the full list of supported licenses. Use the spdx_id field for every license you want to filter. A couple of examples:

# only allow MIT-licensed dependents
- name: Dependency Review
  uses: actions/dependency-review-action@v2
  with:
    allow-licenses: MIT
# Block Apache 1.1 and 2.0 licensed dependents
- name: Dependency Review
  uses: actions/dependency-review-action@v2
  with:
    deny-licenses: Apache-1.1, Apache-2.0

Considerations

  • Checking for licenses is not supported on Enterprise Server.
  • The action will only accept one of the two parameters; an error will be raised if you provide both.
  • By default both parameters are empty (no license checking is performed).
  • We don't have license information for all of your dependents. If we can't detect the license for a dependency we will inform you, but the action won't fail.

Blocking pull requests

The Dependency Review GitHub Action check will only block a pull request from being merged if the repository owner has required the check to pass before merging. For more information, see the documentation on protected branches.

Getting help

If you have bug reports, questions or suggestions please create a new issue.

Contributing

We are grateful for any contributions made to this project.

Please read CONTRIBUTING.MD to get started.

License

This project is released under the MIT License.