{"id":13732473,"url":"https://github.com/peter-evans/link-checker","last_synced_at":"2025-05-08T06:32:20.823Z","repository":{"id":65155639,"uuid":"196596295","full_name":"peter-evans/link-checker","owner":"peter-evans","description":"A GitHub action for link checking repository Markdown and HTML files","archived":true,"fork":false,"pushed_at":"2021-10-18T20:50:33.000Z","size":22,"stargazers_count":49,"open_issues_count":6,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-22T06:18:07.412Z","etag":null,"topics":["github-action","github-issues","html","link-checker","markdown"],"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/peter-evans.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":"2019-07-12T14:47:09.000Z","updated_at":"2024-02-10T03:23:04.000Z","dependencies_parsed_at":"2023-01-13T15:42:31.499Z","dependency_job_id":null,"html_url":"https://github.com/peter-evans/link-checker","commit_stats":{"total_commits":32,"total_committers":4,"mean_commits":8.0,"dds":0.1875,"last_synced_commit":"482f0e73fe7f12e9a27deef9245725e9e7ab7a56"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter-evans%2Flink-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter-evans%2Flink-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter-evans%2Flink-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peter-evans%2Flink-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peter-evans","download_url":"https://codeload.github.com/peter-evans/link-checker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252793661,"owners_count":21805057,"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":["github-action","github-issues","html","link-checker","markdown"],"created_at":"2024-08-03T02:01:58.081Z","updated_at":"2025-05-08T06:32:16.449Z","avatar_url":"https://github.com/peter-evans.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# Link Checker\n[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Link%20Checker-blue.svg?colorA=24292e\u0026colorB=0366d6\u0026style=flat\u0026longCache=true\u0026logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/link-checker)\n\n### :warning: This action is deprecated. Please consider using [lychee-action](https://github.com/lycheeverse/lychee-action).\n\nA GitHub action for link checking repository Markdown and HTML files.\n\nWhen used in conjunction with [Create Issue From File](https://github.com/peter-evans/create-issue-from-file), issues will be created when Link Checker finds connectivity problems with links.\n\n## Usage\n\nUsing with the default settings will check all markdown and HTML files in your repository.\n\n```yml\n    - name: Link Checker\n      uses: peter-evans/link-checker@v1\n```\n\nLink Checker uses [Liche](https://github.com/raviqqe/liche).\nLiche arguments can be passed to the action via the `args` parameter. If not set, the default `-v -r *` will be used.\n\n```yml\n    - name: Link Checker\n      uses: peter-evans/link-checker@v1\n      with:\n        args: -v -r *\n```\n\nSee [Liche's documentation](https://github.com/raviqqe/liche) for further argument details.\n\n#### Optional environment variables\n\nIf Link Checker finds connectivity problems with links the action will output a markdown file containing the error report.\nThe default path is `link-checker/out.md`. The path and filename may be overridden with the following variables.\n\n- `LINKCHECKER_OUTPUT_DIR` - The output directory the markdown error report\n- `LINKCHECKER_OUTPUT_FILENAME` - The error report filename\n\n#### Receiving issues containing the error report\n\nBelow is an example of using this action in conjunction with [Create Issue From File](https://github.com/peter-evans/create-issue-from-file). The workflow executes on a schedule every month. Issues will be created when Link Checker finds connectivity problems with links.\n\n```yml\non:\n  schedule:\n  - cron: '0 0 1 * *'\nname: Check markdown links\njobs:\n  linkChecker:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v2\n      - name: Link Checker\n        uses: peter-evans/link-checker@v1\n      - name: Create Issue From File\n        uses: peter-evans/create-issue-from-file@v2\n        with:\n          title: Link Checker Report\n          content-filepath: ./link-checker/out.md\n          labels: report, automated issue\n```\n\n#### Issue sample\n\n[This link](https://aoushaoueshosuhoshuoeu.com) is intentionally non-existent.\nThe workflow in this repository generated [this sample issue](https://github.com/peter-evans/link-checker/issues/1).\n\n#### Creating a failing check for link errors\n\nTo create a failing check when there are link errors you can use the `exit_code` output from the action as follows.\n\n```yml\non: push\njobs:\n  linkChecker:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v2\n    - name: Link Checker\n      id: lc\n      uses: peter-evans/link-checker@v1\n    - name: Fail if there were link errors\n      run: exit ${{ steps.lc.outputs.exit_code }}\n```\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeter-evans%2Flink-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeter-evans%2Flink-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeter-evans%2Flink-checker/lists"}