Skip to content

Commit 221c806

Browse files
sophiethekingFederico Builes
andauthored
Apply suggestions from code review
Co-authored-by: Federico Builes <[email protected]>
1 parent 7214048 commit 221c806

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ The following configuration options are available.
6161

6262
| Option | Required | Usage |
6363
|------------------|-------------------------------|--------|
64-
| `fail_on_severity` | Optional | Defines the threshold for level of severity (`low`, `moderate`, `high`, `critical`).</br>The action will fail on any pull requests that introduce vulnerabilities of the specified severity level or higher. |
65-
| `allow_licenses` | Optional | Contains a list of allowed licenses. You can find the possible values for this parameter in the [Licenses](/rest/licenses) page of the API documentation.</br>The action will fail on pull requests that introduce dependencies with licenses that do not match the list.|
66-
| `deny_licenses` | Optional | Contains a list of prohibited licenses. You can find the possible values for this parameter in the [Licenses](/rest/licenses) page of the API documentation.</br>The action will fail on pull requests that introduce dependencies with licenses that match the list.|
64+
| `fail-on-severity` | Optional | Defines the threshold for level of severity (`low`, `moderate`, `high`, `critical`).</br>The action will fail on any pull requests that introduce vulnerabilities of the specified severity level or higher. |
65+
| `allow-licenses` | Optional | Contains a list of allowed licenses. You can find the possible values for this parameter in the [Licenses](/rest/licenses) page of the API documentation.</br>The action will fail on pull requests that introduce dependencies with licenses that do not match the list.|
66+
| `deny-licenses` | Optional | Contains a list of prohibited licenses. You can find the possible values for this parameter in the [Licenses](/rest/licenses) page of the API documentation.</br>The action will fail on pull requests that introduce dependencies with licenses that match the list.|
6767

6868
{% tip %}
6969

70-
**Tip:** The `allow_licenses` and `deny_licenses` options are mutually exclusive.
70+
**Tip:** The `allow-licenses` and `deny-licenses` options are mutually exclusive.
7171

7272
{% endtip %}
7373

@@ -90,15 +90,15 @@ jobs:
9090
uses: actions/dependency-review-action@v2
9191
with:
9292
# Possible values: "critical", "high", "moderate", "low"
93-
fail_on_severity: critical
94-
# You can only can only include one of these two options: `allow_licenses` and `deny-licences`
93+
fail-on-severity: critical
94+
# You can only can only include one of these two options: `allow-licenses` and `deny-licences`
9595
# ([String]). Only allow these licenses (optional)
9696
# Possible values: Any `spdx_id` value(s) from https://docs.github.com/en/rest/licenses
97-
# allow_licenses: GPL-3.0, BSD-3-Clause, MIT
97+
# allow-licenses: GPL-3.0, BSD-3-Clause, MIT
9898
9999
# ([String]). Block the pull request on these licenses (optional)
100100
# Possible values: Any `spdx_id` value(s) from https://docs.github.com/en/rest/licenses
101-
# deny_licenses: LGPL-2.0, BSD-2-Clause
101+
# deny-licenses: LGPL-2.0, BSD-2-Clause
102102
```
103103

104104
For further details about the configuration options, see [`dependency-review-action`](https://github.com/actions/dependency-review-action#readme).

0 commit comments

Comments
 (0)