brandonhimpfen/README Section Guard
Ensures required README sections such as License, Contributing, Usage, Installation, or Security are present.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Apr 27, 2026
- License
- MIT
Pinned Snippet
uses: brandonhimpfen/readme-section-guard@e4177aef5b4f45ffb42b05bc343cc696216224e3 # v1.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| readme-path | Path to the README file to check. | no | README.md |
| required-sections | Comma-separated list of required README section headings. | no | Usage,Contributing,License |
| case-sensitive | Whether section heading checks should be case-sensitive. | no | false |
| fail-on-missing-readme | Whether to fail if the README file is missing. | no | true |
Outputs
no outputs