{"id":13901263,"url":"https://github.com/victoriadrake/link-snitch","last_synced_at":"2025-03-21T00:30:25.280Z","repository":{"id":42457005,"uuid":"278969999","full_name":"victoriadrake/link-snitch","owner":"victoriadrake","description":":octocat: GitHub Action to scan your site for broken links so you can fix them 🔗","archived":false,"fork":false,"pushed_at":"2022-02-02T14:10:22.000Z","size":6,"stargazers_count":63,"open_issues_count":1,"forks_count":5,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-15T12:46:06.524Z","etag":null,"topics":["actions","broken-links","continuous-integration","continuous-testing","github-actions","security"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/victoriadrake.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-12T01:28:34.000Z","updated_at":"2025-03-08T21:21:30.000Z","dependencies_parsed_at":"2023-01-11T17:22:12.294Z","dependency_job_id":null,"html_url":"https://github.com/victoriadrake/link-snitch","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.25,"last_synced_commit":"bd8abf087c9fef2637df5f15abb74a047a1c5587"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Flink-snitch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Flink-snitch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Flink-snitch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victoriadrake%2Flink-snitch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/victoriadrake","download_url":"https://codeload.github.com/victoriadrake/link-snitch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244717102,"owners_count":20498280,"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","continuous-integration","continuous-testing","github-actions","security"],"created_at":"2024-08-06T21:01:06.046Z","updated_at":"2025-03-21T00:30:25.021Z","avatar_url":"https://github.com/victoriadrake.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# Link Snitch: scan your site for broken links so you can fix them 🔗\n\nA lightweight GitHub Action that runs [hydra-link-checker](https://github.com/victoriadrake/hydra-link-checker) on the URL you provide, which crawls your site and scans for broken links using multithreaded Python (standard library).\n\nIt's up to you to use Link Snitch responsibly!\n\n## Contributing\n\nThis project simply Action-ifies (that's a word now, right?) the Hydra program. To submit issues or contributions to the link-checking functionality, go to [hydra-link-checker](https://github.com/victoriadrake/hydra-link-checker).\n\n## Use this in your workflow\n\nYou can use this action in a workflow file to run Link Snitch on your choice of trigger, for instance, on a `push` event to the `master` branch:\n\n```yml\n  push:\n    branches:\n      - master\n```\n\nOr on a weekly schedule, say, 04:05 on Monday:\n\n```yml\non:\n  schedule:\n    - cron: '5 4 * * 1'\n```\n\nHere's a full example of a workflow file. See below for `env` instructions.\n\n```yml\nname: Link Snitch\n\non:\n  push:\n    branches:\n      - master\n\nenv:\n  URL: https://example.com\n  FILENAME: report.yaml\n  CONFIG: config.json\n\njobs:\n  build:\n\n    runs-on: ubuntu-latest\n\n    steps:\n      - name: Check out master\n        uses: actions/checkout@master\n        with:\n          fetch-depth: 1\n      - name: Report broken links\n        uses: victoriadrake/link-snitch@master\n```\n\n### Setting the `env` variables\n\nThis action requires a single environment variable, `URL`. Set this to the fully qualified address of your site, including schema (the `https://` part).\n\nOptional variables include:\n\n- `FILENAME`: See [view results](#view-results) below.\n- `CONFIG`: Your Hydra configuration file. See [Configuration for Hydra](https://github.com/victoriadrake/hydra-link-checker#configuration).\n\n### Workflow customization\n\nSee full instructions for [Configuring and managing workflows](https://help.github.com/en/actions/configuring-and-managing-workflows).\n\nFor help editing the YAML file, see [Workflow syntax for GitHub Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions).\n\n## View results\n\nBy default, the report is YAML formatted and output to `stdout` in your Action run. If you wish to save this to a file that you can download, set `FILENAME` to a file name of your choosing, then use `actions/upload-artifact` in your workflow. See [Uploading build and test artifacts](https://docs.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifacts#uploading-build-and-test-artifacts) for more.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictoriadrake%2Flink-snitch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvictoriadrake%2Flink-snitch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictoriadrake%2Flink-snitch/lists"}