docs: document native GitHub Action inputs for override hygiene - #910
Merged
Conversation
The override-hygiene CI-integration section only showed raw CLI flags and had a duplicated example. Add a GitHub Action subsection covering the native inputs (check-overrides, overrides, overrides-fail-on, check-network, audit-log) with inline and dedicated-audit examples, and fix the duplicate CLI example.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The override-hygiene CI-integration docs only showed raw CLI flags, so anyone wiring up the GitHub Action had no way to discover that override hygiene is available through native Action inputs.
This adds a
### GitHub Actionsubsection under CI integration covering the two modes - inlinecheck-overridesand a dedicatedoverridesaudit step - with copy-run YAML and an input reference table forcheck-overrides,overrides,overrides-fail-on,check-network, andaudit-log. It also removes a duplicated example from the existing CLI subsection.Docs-only. Verified with a clean
cd website && npm run build.Closes #909