neondeerdatalabs/Checkredirects.io

Check URLs for redirects, broken links, and errors in CI. Fail builds on problems, post results to PRs.

Trust Signals

name	description	required	default
api-key	Your Checkredirects.io API key (starts with httpnd_).	yes	—
urls	URLs to check, one per line. Mutually exclusive with urls-file and sitemap.	no	""
urls-file	Path to a file containing URLs (one per line). Path is resolved against the workspace.	no	""
sitemap	Sitemap URL. The action will fetch and parse it server-side and check every URL it contains.	no	""
fail-on-error	Fail the step if any URL returns 4xx/5xx or has a connection error.	no	true
fail-on-redirect	Fail the step if any URL redirects at all (one or more hops).	no	false
fail-on-chain	Fail the step if any URL has a redirect chain (two or more hops).	no	false
user-agent	User agent preset (e.g. googlebot, chrome-desktop) or a custom string.	no	""
max-redirects	Maximum redirects to follow per URL.	no	10
https-only	Reject HTTP fallback. If a URL is unreachable on HTTPS the check fails instead of retrying on HTTP.	no	false
share-results	Create a public share link for the batch and include it in the PR comment. Off by default — results are private unless you opt in.	no	false
comment-on-pr	Post results as a comment on the pull request that triggered the workflow. No-op on push events.	no	true
dedupe	Remove duplicate URLs before submission. Reported in the summary when duplicates are found.	no	true
timeout-seconds	Maximum wall-clock seconds to wait for the batch to complete before failing.	no	300
base-url	API base URL. Override for self-hosted or staging.	no	https://api.checkredirects.io

name	description
total	Total URLs submitted to the batch (after dedupe).
completed	URLs successfully checked.
errors	Count of URLs with a connection error or a 4xx/5xx final status.
redirects	Count of URLs that redirected (one or more hops).
chains	Count of URLs with a redirect chain (two or more hops).
pass	"true" if no fail-on threshold was hit, "false" otherwise. Authoritative — set by the render step after applying fail-on policy.
batch-id	The batch job ID. Use it to fetch full results from the API later.
share-url	Public share URL for the batch (only set when share-results=true).
results-json	Path to a JSON file in $RUNNER_TEMP containing the full merged results.