Skip to content

[BUG] Underscores in configuration file don't work whereas dashes do #909

Open
@ChesterEcwid

Description

@ChesterEcwid

Describe the bug
Hi! Docs contain explicit note about underscores in config file
https://github.com/actions/dependency-review-action?tab=readme-ov-file#option-2-using-an-external-configuration-file

For external configuration files, the option names use underscores instead of dashes. Example: fail_on_severity

I use separate configuration file for dependency-review-action. If I use underscores in it, configuration options are not applied, they're just skipped. I tried to change underscores to dashes, after that options are applied.

To Reproduce
Steps to reproduce the behavior:

  1. Use separate config file for workflow action.
  2. Set option names with underscores (for example, allow_licenses).
  3. Try to run workflow.
  4. See in result that licenses listed in allow-licenses options are detected as incompatible.

Expected behavior
I think it's enough to change docs: remove not about underscores and fix example code in this chapter https://github.com/actions/dependency-review-action?tab=readme-ov-file#option-2-using-an-external-configuration-file.

Action version
v4

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions