dvdstelt/HyperHawk Link Checker
Scans markdown files for broken links and posts PR review comments
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | GitHub token for API calls and posting PR comments | yes | ${{ github.token }} |
| files | Glob patterns for files to scan (comma-separated), defaults to all .md/.mdx | no | **/*.md,**/*.mdx |
| check-external | Whether to check external HTTP links | no | true |
| check-same-org | Whether to check same-org GitHub links via API | no | true |
| check-relative | Whether to check relative file links (../x.md, ./x.md, folder/x.md). Root-relative links (/x.md) are always checked. | no | true |
| relative-suggestion-depth | Relative links that traverse this many directory levels or fewer are not given a root-relative conversion suggestion (0 = only same-folder links are exempt; 1 also exempts ../x.md and folder/x.md). Maximum 5; to skip relative-link checks entirely, set check-relative to false instead. | no | 0 |
| ignore-patterns | Comma-separated list of URL patterns to ignore (regex) | no | "" |
| timeout | Timeout in milliseconds for external link checks | no | 10000 |
| concurrency | Number of concurrent link checks | no | 5 |
| strict | Fail the workflow if broken links are found | no | false |
| skip-code-blocks | When true, links inside fenced code blocks (``` or ~~~) are skipped and not checked. | no | false |
| report-only-changed | When true, only report issues on lines that were changed in the PR. Broken links on unchanged lines are silently skipped instead of producing check warning annotations. | no | false |
| cross-repo-token | Optional separate token used only for same-org GitHub link checks. Use a GitHub App token with Contents: Read permission to check links into private repositories. When omitted, the main token is used for all checks. | no | "" |
Outputs
no outputs