diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml index e03e666..aac6f5c 100644 --- a/.github/workflows/dependency-review.yml +++ b/.github/workflows/dependency-review.yml @@ -1,25 +1,42 @@ +# Dependency Review Action +# +# This Action will scan dependency manifest files that change as part of a Pull Request, +# surfacing known-vulnerable versions of the packages declared or updated in the PR. +# Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable +# packages will be blocked from merging. +# +# Source repository: https://github.com/actions/dependency-review-action +# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement --- name: Dependency Review - on: pull_request: branches: - master +# If using a dependency submission action in this workflow this permission will need to be set to: +# +# permissions: +# contents: write +# +# https://docs.github.com/en/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api permissions: contents: read + # Write permissions for pull-requests are required for using the `comment-summary-in-pr` option, comment out if you aren't using this option + pull-requests: write jobs: dependency-review: name: Dependency Review runs-on: ubuntu-latest - steps: - - name: Checkout Code + - name: Checkout Repository uses: actions/checkout@v7 - name: Dependency Review uses: actions/dependency-review-action@v5 + # Commonly enabled options, see https://github.com/actions/dependency-review-action#configuration-options for all available options. with: - fail-on-severity: high - deny-licenses: AGPL-1.0-or-later + comment-summary-in-pr: always + allow-licenses: GPL-2.0-or-later, LGPL-2.1-or-later, GFDL-1.1-or-later, MIT, MPL-2.0, CC-BY-4.0, CC-BY-SA-4.0, Apache-2.0 + allow-dependencies-licenses: "pkg:actions/dependency-review-action"