actions-marketplace-validations/urlchecker-action
Automatically check for broken links in a project files. This includes python, markdwon, restructured text files and more.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Nov 15, 2022
- License
- MIT
Pinned Snippet
uses: actions-marketplace-validations/urlstechie_urlchecker-action@b643b43e2ac605e1475331c7b67247d242b7dce4 # no releases — HEAD as of 2026-07-10tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| git_path | A project to clone. If not provided, assumes already cloned in the present working directory. | no | — |
| subfolder | A subfolder to parse instead of the root directory. | no | — |
| force_pass | Force pass of checking, regardless of the result. | no | — |
| branch | If a project (git_path) is defined, use this branch. Defaults to master | no | master |
| cleanup | Cleanup (delete) repository to check after doing so (appropriate for when clone is done) | no | false |
| include_files | A comma seperated list of paths or patterns to include. | no | "" |
| file_types | A comma-separated list of file types to cover in the URL checks | no | .md,.py,.rst,.html |
| print_all | Choose whether to include file with no URLs in the prints. | no | false |
| verbose | Choose whether to print a more verbose end summary with files and broken URLs. | no | false |
| serial | Run in serial (good for debugging) | no | false |
| retry_count | If a request fails, retry this number of times. Defaults to 1 | no | 1 |
| save | A csv file path to save the results to. | no | "" |
| timeout | The timeout (seconds) to provide to requests to wait for a response. | no | 5 |
| exclude_urls | A comma seperated links to exclude during URL checks. | no | "" |
| exclude_patterns | A comma seperated patterns to exclude during URL checks. | no | "" |
| exclude_files | A comma seperated list of paths or patterns to exclude during URL checks. | no | "" |
| workers | Number of workers to run in parallel (defaults to 9) | no | — |
Outputs
no outputs