add doc on allow-ghsas to readme
This commit is contained in:
@@ -75,7 +75,7 @@ A string representing the path to an external configuraton file. By
|
|||||||
default external configuration files are not used.
|
default external configuration files are not used.
|
||||||
|
|
||||||
**Possible values**: A string representing the absolute path to the
|
**Possible values**: A string representing the absolute path to the
|
||||||
configuration file.
|
configuration file.
|
||||||
|
|
||||||
**Example**: `config-file: ./.github/dependency-review-config.yml`.
|
**Example**: `config-file: ./.github/dependency-review-config.yml`.
|
||||||
|
|
||||||
@@ -97,6 +97,7 @@ support. The default value is `development, runtime`.
|
|||||||
**Inline example**: `fail-on-scopes: development, runtime`
|
**Inline example**: `fail-on-scopes: development, runtime`
|
||||||
|
|
||||||
**YAML example**:
|
**YAML example**:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# this prevents scanning development dependencies
|
# this prevents scanning development dependencies
|
||||||
fail-on-scopes:
|
fail-on-scopes:
|
||||||
@@ -113,6 +114,7 @@ https://docs.github.com/en/rest/licenses.
|
|||||||
**Inline example**: `allow-licenses: BSD-3-Clause, MIT`
|
**Inline example**: `allow-licenses: BSD-3-Clause, MIT`
|
||||||
|
|
||||||
**YAML example**:
|
**YAML example**:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
allow-licenses:
|
allow-licenses:
|
||||||
- BSD-3-Clause
|
- BSD-3-Clause
|
||||||
@@ -130,12 +132,29 @@ https://docs.github.com/en/rest/licenses.
|
|||||||
**Inline example**: `deny-licenses: LGPL-2.0, BSD-2-Clause`
|
**Inline example**: `deny-licenses: LGPL-2.0, BSD-2-Clause`
|
||||||
|
|
||||||
**YAML example**:
|
**YAML example**:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
deny-licenses:
|
deny-licenses:
|
||||||
- LGPL-2.0
|
- LGPL-2.0
|
||||||
- BSD-2-Clause
|
- BSD-2-Clause
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### allow-ghsas
|
||||||
|
|
||||||
|
Add a custom list of GHSA ids you do not want the action to block on.
|
||||||
|
|
||||||
|
**Possible values**: Any valid advisory GHSA ids.
|
||||||
|
|
||||||
|
**Inline example**: `allow-ghsas: GHSA-abcd-1234-5679, GHSA-efgh-1234-5679`
|
||||||
|
|
||||||
|
**YAML example**:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
allow-ghsas:
|
||||||
|
- GHSA-abcd-1234-5679
|
||||||
|
- GHSA-efgh-1234-5679
|
||||||
|
```
|
||||||
|
|
||||||
### base-ref/head-ref
|
### base-ref/head-ref
|
||||||
|
|
||||||
Provide custom git references for the git base/head when performing
|
Provide custom git references for the git base/head when performing
|
||||||
@@ -146,6 +165,7 @@ this. The values need to be specified for all other event types.
|
|||||||
**Possible values**: Any valid git ref(s) in your project.
|
**Possible values**: Any valid git ref(s) in your project.
|
||||||
|
|
||||||
**Example**:
|
**Example**:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
base-ref: 8bb8a58d6a4028b6c2e314d5caaf273f57644896
|
base-ref: 8bb8a58d6a4028b6c2e314d5caaf273f57644896
|
||||||
head-ref: 69af5638bf660cf218aad5709a4c100e42a2f37b
|
head-ref: 69af5638bf660cf218aad5709a4c100e42a2f37b
|
||||||
@@ -163,18 +183,18 @@ file:
|
|||||||
- name: Dependency Review
|
- name: Dependency Review
|
||||||
uses: actions/dependency-review-action@v2
|
uses: actions/dependency-review-action@v2
|
||||||
with:
|
with:
|
||||||
config-file: "./.github/dependency-review-config.yml"
|
config-file: './.github/dependency-review-config.yml'
|
||||||
```
|
```
|
||||||
|
|
||||||
And then create the file in the path you just specified. **All of these fields are
|
And then create the file in the path you just specified. **All of these fields are
|
||||||
optional**:
|
optional**:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
fail-on-severity: "critical"
|
fail-on-severity: 'critical'
|
||||||
allow-licenses:
|
allow-licenses:
|
||||||
- "GPL-3.0"
|
- 'GPL-3.0'
|
||||||
- "BSD-3-Clause"
|
- 'BSD-3-Clause'
|
||||||
- "MIT"
|
- 'MIT'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Inline Configuration
|
### Inline Configuration
|
||||||
|
|||||||
Reference in New Issue
Block a user