{"id":13911183,"url":"https://github.com/harrisonpim/broken-link-checker","last_synced_at":"2025-07-18T10:32:47.847Z","repository":{"id":42681341,"uuid":"452864687","full_name":"harrisonpim/broken-link-checker","owner":"harrisonpim","description":"🔗  a github action to periodically check a site for broken links","archived":false,"fork":false,"pushed_at":"2022-03-28T19:13:44.000Z","size":2672,"stargazers_count":2,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-25T05:18:15.852Z","etag":null,"topics":["actions","broken-links","github-actions","seo","sitemap"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/harrisonpim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":null,"code_of_conduct":"docs/code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-27T22:24:27.000Z","updated_at":"2022-11-26T07:53:30.000Z","dependencies_parsed_at":"2023-01-11T17:22:14.108Z","dependency_job_id":null,"html_url":"https://github.com/harrisonpim/broken-link-checker","commit_stats":{"total_commits":29,"total_committers":4,"mean_commits":7.25,"dds":"0.24137931034482762","last_synced_commit":"63d30c00f712744e69db4df3900db882e7807322"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/harrisonpim/broken-link-checker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrisonpim%2Fbroken-link-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrisonpim%2Fbroken-link-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrisonpim%2Fbroken-link-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrisonpim%2Fbroken-link-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harrisonpim","download_url":"https://codeload.github.com/harrisonpim/broken-link-checker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrisonpim%2Fbroken-link-checker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265742512,"owners_count":23820859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","broken-links","github-actions","seo","sitemap"],"created_at":"2024-08-07T00:02:00.472Z","updated_at":"2025-07-18T10:32:47.480Z","avatar_url":"https://github.com/harrisonpim.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# 🔗 Broken link checker\n\nThis action takes a sitemap as input, and checks each of its URLs for broken links.\n\n## Inputs\n\n- `sitemap`: **Required** The URL of the sitemap to crawl.\n- `allowList`: **Optional** A list of URLs to ignore. Should be formatted as a JSON array, eg `[\"https://example.com/\", \"https://example.com/blog\"]`.\n\n## Outputs\n\nIf no broken links are found, the action passes silently. If any links are broken, the action will fail with:\n\n- `broken-links`: A list of broken links, with the page where they were found.\n\n## Example usage\n\nCopy the following into a file called `.github/workflows/broken-links.yml` in your repo, and remember to edit the `sitemap` input to point to your own sitemap.\n\n```yaml\nname: Check site for broken links\non:\n  schedule:\n    - cron: \"0 0 * * 0\"\n    # Runs every Sunday at midnight\n    # see https://crontab.guru/#0_0_*_*_0\njobs:\n  check-site-for-broken-links:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: harrisonpim/broken-link-checker@0.2.1\n        with:\n          sitemap: https://harrisonpim.com/sitemap.xml\n```\n\n## Further information\n\nSee the [broken-link-checker documentation](./docs/) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharrisonpim%2Fbroken-link-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharrisonpim%2Fbroken-link-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharrisonpim%2Fbroken-link-checker/lists"}