Version 2.4.1

What's Changed

• Added Update Default Lychee version workflow by @Arteiii in #284
• Use temporary directory for lychee installation by @mre in #287
• Fix lychee version check by @mondeja in #288

Full Changelog: v2...v2.4.1

Version 2.4.0

What's Changed

• lychee now has a new task output, which allows to track which links got fixed more easily.
  It looks like this:

  [test.html]:

  • [404] https://en.wikipedia.org/wiki/foo | Network error: Not Found
  • [404] https://en.wikipedia.org/wiki/bar | Network error: Not Found
  • [ERROR] https://example.com/baz | Network error: error sending request for url (https://example.com/baz) Maybe a certificate error?

  Each broken link has a checkbox that can be ticked off once fixed. Credit goes to @Arteiii for the idea and the implementation.
  See #274 for more information.

• Update To latest lychee Release by @Arteiii in #279

• Add workingDirectory argument by @mre in #283

New Contributors

• @Arteiii made their first contribution in #279

Full Changelog: v2...v2.4.0

Version 2.3.0

What's Changed

• feat: support ARM workers by @LesnyRumcajs in #273

New Contributors

• @LesnyRumcajs made their first contribution in #273

Full Changelog: v2...v2.3.0

Version 2.2.0

What's Changed

• Fix if expressions in GitHub actions by @YDX-2147483647 in #265
• Update README.md to include continue-on-error: true in action by @psobolewskiPhD in #267
• Bump default version to latest (0.18.0) by @trask in #269

New Contributors

• @psobolewskiPhD made their first contribution in #267
• @trask made their first contribution in #269

Full Changelog: v2...v2.2.0

Version 2.1.0

What's Changed

• Add missing argument failIfEmpty by @LitoMore in #261
• Fix bugs about the exit code by @YDX-2147483647 in #262
• Bump lychee version to 0.17.0 by @mre in #263

New Contributors

• @LitoMore made their first contribution in #261
• @YDX-2147483647 made their first contribution in #262

Full Changelog: v2...v2.1.0

Version 2.0.2

What's Changed

• Fix a typos by @szepeviktor in #257
• Document and use correct permissions in the GitHub workflows by @dscho in #258
• Add security policy by @mondeja in #259

New Contributors

• @szepeviktor made their first contribution in #257
• @mondeja made their first contribution in #259

Full Changelog: v2...v2.0.2

Version 2.0.1

What's Changed

• Don't remove the lychee config file by @dmathieu in #255
• Bump lycheeverse/lychee-action from 1 to 2 by @dependabot in #252
• Fix variable name in docs by @kdeldycke in #253

New Contributors

• @dmathieu made their first contribution in #255

Full Changelog: v2...v2.0.1

Version 2.0.0

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

Fail pipeline if no links were found

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

Exit code handling

In this version, we changed the environment variable for the lychee exit code from GITHUB_ENV to GITHUB_OUTPUT.
Please update your scripts. For more details, see #245.

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

What's Changed

• feat: change to use the full version tag with v-* prefix by @kemingy in #204
• Add failIfEmpty argument (fixes #84) by @mre in #86
• Fail pipeline on error by default (fixes #71) by @mre in #85
• Exit in case output is set in args and action input by @mre in #227
• v1 will automatically use latest version by @jacobdalamb in #228
• Remove unneeded text by @jacobdalamb in #229
• Clarify README.md defaults by @paddyroddy in #230
• Adjust for new asset naming scheme by @dscho in #234
• Test various lychee versions by @mre in #235
• Better cleanup of old lychee assets by @mre in #237
• Bump peter-evans/create-issue-from-file from v4 to v5 by @AndreiCherniaev in #241
• Remove dots from table by @AndreiCherniaev in #242
• README: update actions/cache to v4 by @sebastiaanspeck in #243
• Set exit_code correctly as output by @sebastiaanspeck in #245
• action: fix failing CI by @sebastiaanspeck in #246
• Split up steps in action by @mre in #248
• Bump version to 0.16.x, respect new tag names by @mre in #249
• Test latest lychee version tag by @mre in #236

New Contributors

• @kemingy made their first contribution in #204
• @paddyroddy made their first contribution in #230
• @dscho made their first contribution in #234
• @AndreiCherniaev made their first contribution in #241
• @sebastiaanspeck made their first contribution in #243

Full Changelog: v1...v1.11.0

Version 1.10.0

What's Changed

• Update actions/checkout to version 4 by @jacobdalamb in #224
• Bump lychee to 0.15.0 by @mre in #226

New Contributors

• @jacobdalamb made their first contribution in #224

Full Changelog: v1.9.3...v1.10.0

Version 1.0.0

First release of the lychee Github action — an action to check for broken links in Markdown, HTML, and text files using lychee, a fast link checker written in Rust.