Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1c73553

Browse files
authored
Merge pull request #960 from ahpook/ahpook/address-docs-dashes
Address discrepancy between docs and reality
2 parents fac3d41 + 5558c35 commit 1c73553

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
# dependency-review-action
22

3-
- [Overview](#overview)
4-
- [Installation](#installation)
5-
- [Configuration](#configuration)
6-
- [Using dependency review action to block a pull request from being merged](#using-dependency-review-action-to-block-a-pull-request-from-being-merged)
7-
- [Outputs](#outputs)
8-
- [Getting help](#getting-help)
9-
- [Contributing](#contributing)
10-
- [License](#license)
3+
- [dependency-review-action](#dependency-review-action)
4+
- [Overview](#overview)
5+
- [Viewing the results](#viewing-the-results)
6+
- [Installation](#installation)
7+
- [Installation (standard)](#installation-standard)
8+
- [Installation (GitHub Enterprise Server)](#installation-github-enterprise-server)
9+
- [Configuration](#configuration)
10+
- [Configuration options](#configuration-options)
11+
- [Configuration methods](#configuration-methods)
12+
- [Option 1: Using inline configuration](#option-1-using-inline-configuration)
13+
- [Option 2: Using an external configuration file](#option-2-using-an-external-configuration-file)
14+
- [`OTHER` in license strings](#other-in-license-strings)
15+
- [Further information](#further-information)
16+
- [Using dependency review action to block a pull request from being merged](#using-dependency-review-action-to-block-a-pull-request-from-being-merged)
17+
- [Outputs](#outputs)
18+
- [Getting help](#getting-help)
19+
- [Contributing](#contributing)
20+
- [License](#license)
1121

1222
## Overview
1323

@@ -205,15 +215,12 @@ You can use an external configuration file to specify settings for this action.
205215
3. Create the configuration file in the path you specified for `config-file`.
206216
4. In the configuration file, specify your chosen settings.
207217
```yaml
208-
fail_on_severity: 'critical'
209-
allow_licenses:
218+
fail-on-severity: 'critical'
219+
allow-licenses:
210220
- 'GPL-3.0'
211221
- 'BSD-3-Clause'
212222
- 'MIT'
213223
```
214-
> [!NOTE]
215-
> For external configuration files, the option names use underscores instead of dashes.
216-
> Example: `fail_on_severity`
217224

218225
#### `OTHER` in license strings
219226

0 commit comments

Comments
 (0)