Skip to content

Address discrepancy between docs and reality #960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 18, 2025

Conversation

ahpook
Copy link
Contributor

@ahpook ahpook commented Aug 16, 2025

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 4b4ec08

Closes #909

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 4b4ec08

Closes actions#909
@Copilot Copilot AI review requested due to automatic review settings August 16, 2025 00:19
@ahpook ahpook requested a review from a team as a code owner August 16, 2025 00:19
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses a documentation inconsistency by correcting the external configuration file format to use dashes instead of underscores, aligning with the actual code behavior. The documentation previously incorrectly stated that external config files needed underscores, when the code actually transforms dashes to underscores automatically.

  • Updated table of contents to include additional section links
  • Corrected external configuration file examples to use dashes (e.g., fail-on-severity instead of fail_on_severity)
  • Removed incorrect note about needing to use underscores in external config files

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

Copy link
Contributor

@claire153 claire153 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for updating the docs! It does work with dashes, I tested an external config file locally with deny-license

@dangoor dangoor merged commit 1c73553 into actions:main Aug 18, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Underscores in configuration file don't work whereas dashes do
3 participants