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 GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stalelast commit Nov 15, 2022
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: actions-marketplace-validations/urlstechie_urlchecker-action@b643b43e2ac605e1475331c7b67247d242b7dce4 # no releases — HEAD as of 2026-07-10

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
git_pathA project to clone. If not provided, assumes already cloned in the present working directory.no
subfolderA subfolder to parse instead of the root directory.no
force_passForce pass of checking, regardless of the result.no
branchIf a project (git_path) is defined, use this branch. Defaults to masternomaster
cleanupCleanup (delete) repository to check after doing so (appropriate for when clone is done)nofalse
include_filesA comma seperated list of paths or patterns to include.no""
file_typesA comma-separated list of file types to cover in the URL checksno.md,.py,.rst,.html
print_allChoose whether to include file with no URLs in the prints.nofalse
verboseChoose whether to print a more verbose end summary with files and broken URLs.nofalse
serialRun in serial (good for debugging)nofalse
retry_countIf a request fails, retry this number of times. Defaults to 1no1
saveA csv file path to save the results to.no""
timeoutThe timeout (seconds) to provide to requests to wait for a response.no5
exclude_urlsA comma seperated links to exclude during URL checks.no""
exclude_patternsA comma seperated patterns to exclude during URL checks.no""
exclude_filesA comma seperated list of paths or patterns to exclude during URL checks.no""
workersNumber of workers to run in parallel (defaults to 9)no

no outputs