Lychee Broken Link Checker

Version updated for lycheeverse/lychee-action to version v2.0.0.

  • This action is used across all versions by 18,746 repositories.

Go to the GitHub Marketplace to find the latest changes.

Release notes

Breaking Changes

Note: This release improves the action’s robustness by changing default behaviors. Changes are only required if you want to opt out of the new failure conditions. Most users won’t need to modify their existing configurations.

Fail pipeline on error by default

We’ve changed the default behavior: pipelines will now fail on broken links automatically. This addresses user feedback that not failing on broken links was unexpected (see issue #71).

What you need to do:

  • Update to version 2 of this action to apply this change.
  • Users of the lychee-action@master branch don’t need to make any changes, as fail: true has been the default there for a while.
  • If you prefer the old behavior, explicitly set fail to false when updating:
- name: Link Checker
  id: lychee
  uses: lycheeverse/lychee-action@v2
  with:
    fail: false  # Don't fail action on broken links

Similar to the above change, we now fail the pipeline if no links are found during a run. This helps warn users about potential configuration issues.

What you need to do:

  • If you expect links to be found in your pipeline run, you don’t need to do anything.
  • If you expect no links in your pipeline run, you can opt out like this:
- name: Link Checker
  id: lychee
  uses: lycheeverse/lychee-action@v2
  with:
    failIfEmpty: false  # Don't fail action if no links were found

For a more detailed description of the technical aspects behind these changes, please see the full changelog below.

What’s Changed

New Contributors

Full Changelog: https://github.com/lycheeverse/lychee-action/compare/v1...v1.11.0