actions-marketplace-validations/Lychee Broken Link Checker
Quickly check links in Markdown, HTML, and text files
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| args | Lychee arguments (https://github.com/lycheeverse/lychee#commandline-parameters) | no | --verbose --no-progress './**/*.md' './**/*.html' './**/*.rst' |
| debug | Enable debug output in action (set -x). Helpful for troubleshooting. | no | false |
| fail | Fail entire pipeline on error (i.e. when lychee exit code is not 0) | no | true |
| failIfEmpty | Fail entire pipeline if no links were found | no | true |
| format | Summary output format (e.g. json) | no | markdown |
| jobSummary | Write GitHub job summary at the end of the job (written on Markdown output only) | no | true |
| lycheeVersion | Use custom version of lychee link checker | no | v0.23.0 |
| output | Summary output file path | no | lychee/out.md |
| checkbox | Add Markdown Styled Checkboxes to the output | no | true |
| token | Your GitHub Access Token, defaults to: {{ github.token }} | no | ${{ github.token }} |
| workingDirectory | Directory to run lychee in | no | . |
Outputs
| name | description |
|---|---|
| exit_code | The exit code returned from Lychee |