From 5558c35bb3e79ef0a0f2d9896a56060e24df9bea Mon Sep 17 00:00:00 2001 From: Eric Sorenson Date: Fri, 15 Aug 2025 17:16:55 -0700 Subject: [PATCH] Address discrepancy between docs and reality The documentation used to say that you needed to transform keys in external config files from using `-` to `_`, but in reality the code transforms `-` to `_` regardless of where they occur. See 4b4ec08f7bcd71379df3485946d95a71a23d9091 Closes #909 --- README.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b0cf179..78176ff 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ # dependency-review-action -- [Overview](#overview) -- [Installation](#installation) -- [Configuration](#configuration) -- [Using dependency review action to block a pull request from being merged](#using-dependency-review-action-to-block-a-pull-request-from-being-merged) -- [Outputs](#outputs) -- [Getting help](#getting-help) -- [Contributing](#contributing) -- [License](#license) +- [dependency-review-action](#dependency-review-action) + - [Overview](#overview) + - [Viewing the results](#viewing-the-results) + - [Installation](#installation) + - [Installation (standard)](#installation-standard) + - [Installation (GitHub Enterprise Server)](#installation-github-enterprise-server) + - [Configuration](#configuration) + - [Configuration options](#configuration-options) + - [Configuration methods](#configuration-methods) + - [Option 1: Using inline configuration](#option-1-using-inline-configuration) + - [Option 2: Using an external configuration file](#option-2-using-an-external-configuration-file) + - [`OTHER` in license strings](#other-in-license-strings) + - [Further information](#further-information) + - [Using dependency review action to block a pull request from being merged](#using-dependency-review-action-to-block-a-pull-request-from-being-merged) + - [Outputs](#outputs) + - [Getting help](#getting-help) + - [Contributing](#contributing) + - [License](#license) ## Overview @@ -206,15 +216,12 @@ You can use an external configuration file to specify settings for this action. 3. Create the configuration file in the path you specified for `config-file`. 4. In the configuration file, specify your chosen settings. ```yaml - fail_on_severity: 'critical' - allow_licenses: + fail-on-severity: 'critical' + allow-licenses: - 'GPL-3.0' - 'BSD-3-Clause' - 'MIT' ``` - > [!NOTE] - > For external configuration files, the option names use underscores instead of dashes. - > Example: `fail_on_severity` #### `OTHER` in license strings