-
Notifications
You must be signed in to change notification settings - Fork 140
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
Conversation
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
There was a problem hiding this 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 offail_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.
There was a problem hiding this 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
…2 [skip ci] Bumps [actions/dependency-review-action](https://github.com/actions/dependency-review-action) from 4.7.1 to 4.7.2. Release notes *Sourced from [actions/dependency-review-action's releases](https://github.com/actions/dependency-review-action/releases).* > 4.7.2 > ----- > > What's Changed > -------------- > > * Add Missing Languages to CodeQL Advanced Configuration by [`@KyFaSt`](https://github.com/KyFaSt) in [actions/dependency-review-action#945](https://redirect.github.com/actions/dependency-review-action/pull/945) > * Deprecate deny lists by [`@claire153`](https://github.com/claire153) in [actions/dependency-review-action#958](https://redirect.github.com/actions/dependency-review-action/pull/958) > * Address discrepancy between docs and reality by [`@ahpook`](https://github.com/ahpook) in [actions/dependency-review-action#960](https://redirect.github.com/actions/dependency-review-action/pull/960) > > New Contributors > ---------------- > > * [`@KyFaSt`](https://github.com/KyFaSt) made their first contribution in [actions/dependency-review-action#945](https://redirect.github.com/actions/dependency-review-action/pull/945) > * [`@claire153`](https://github.com/claire153) made their first contribution in [actions/dependency-review-action#958](https://redirect.github.com/actions/dependency-review-action/pull/958) > * [`@ahpook`](https://github.com/ahpook) made their first contribution in [actions/dependency-review-action#960](https://redirect.github.com/actions/dependency-review-action/pull/960) > > **Full Changelog**: <actions/dependency-review-action@v4...v4.7.2> Commits * [`bc41886`](actions/dependency-review-action@bc41886) Cut 4.7.2 version release ([#964](https://redirect.github.com/actions/dependency-review-action/issues/964)) * [`1c73553`](actions/dependency-review-action@1c73553) Merge pull request [#960](https://redirect.github.com/actions/dependency-review-action/issues/960) from ahpook/ahpook/address-docs-dashes * [`fac3d41`](actions/dependency-review-action@fac3d41) Bump the minor-updates group across 1 directory with 5 updates ([#956](https://redirect.github.com/actions/dependency-review-action/issues/956)) * [`d8073c4`](actions/dependency-review-action@d8073c4) Merge pull request [#958](https://redirect.github.com/actions/dependency-review-action/issues/958) from actions/claire153/deprecate-deny-lists * [`77184c6`](actions/dependency-review-action@77184c6) Fix tests * [`5558c35`](actions/dependency-review-action@5558c35) Address discrepancy between docs and reality * [`e85d57a`](actions/dependency-review-action@e85d57a) Remove test code * [`3eb6279`](actions/dependency-review-action@3eb6279) Re-add test package. Only show warning in summary if option is used. Update c... * [`7cf33ac`](actions/dependency-review-action@7cf33ac) Remove test deny list * [`493bee0`](actions/dependency-review-action@493bee0) Remove test package * Additional commits viewable in [compare view](actions/dependency-review-action@da24556...bc41886) [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
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