v2.9.0

Summary

This release updates the default lychee version from v0.23.0 to v0.24.2.

The main reason for this release is compatibility with the new lychee 0.24.x release artifacts. Starting with lychee v0.24.0, the archive layout changed, and the lychee binary may now be packaged inside a subdirectory. lychee-action now detects that layout automatically, so users can upgrade without changing their workflows.

If you use:

uses: lycheeverse/lychee-action@v2

you will get the new version once the floating v2 tag has been updated. If you pin exact versions, update to:

uses: lycheeverse/lychee-action@v2.9.0

What’s new from lychee v0.24.x

Better diagnostics

lychee now reports line and column numbers for detected links. This makes broken link reports easier to act on, especially in larger documentation sites or generated reports.

Text fragment checking

lychee can now check URL text fragments, such as links containing #:~:text=.... This helps catch links that point to a valid page but no longer points to the intended highlighted text.

Sitemap support

lychee can now read sitemap.xml inputs. This is useful for checking published websites or generated documentation sites where the sitemap is the easiest source of URLs to validate.

JUnit output

lychee now supports JUnit output. This makes it easier to integrate link checking results with CI systems and test reporting tools that understand JUnit XML.

Redirect and remap visibility

lychee can now show redirects and remaps more clearly. This helps explain why a URL was checked as a different final URL and makes debugging link-checking behavior easier.

Multiple config files

lychee now supports multiple configuration files and expanded config handling. This is useful for repositories that split documentation, website, or package-specific link-checking settings.

Timeout handling

lychee can now accept timeouts explicitly. This gives users more control over how strict their link checks should be for flaky or slow endpoints.

Fixes and reliability improvements

Fixed lychee 0.24.x archive compatibility

lychee-action now handles the new lychee release archive layout by detecting whether the lychee binary is inside a subdirectory.

This fixes compatibility with lychee 0.24.x.

More stable installation path

The action now installs lychee into $RUNNER_TEMP/lychee/bin instead of $HOME.

This avoids failures on runners where $HOME differs between composite action steps. In those environments, the action could add one directory to PATH but install the binary somewhere else, causing lychee: command not found.

Safer automatic lychee version updates

The workflow that checks for new lychee releases now guards against null release versions before creating update PRs. This prevents invalid automated PRs such as “Update lycheeVersion to null”.

Dependency updates

• Updated actions/checkout from v6 to v7
• Updated actions/cache from v5 to v6

Upstream lychee changelog

For the full lychee changelog, see:

• https://github.com/lycheeverse/lychee/releases/tag/lychee-v0.24.0
• https://github.com/lycheeverse/lychee/releases/tag/lychee-v0.24.1
• https://github.com/lycheeverse/lychee/releases/tag/lychee-v0.24.2

What’s Changed

• bump default to 0.24.1 and auto-detect lychee bin in subfolder by @kaitlyndotmoe in #330
• fixes #322 check for null by @bgermann in #336
• Install into $RUNNER_TEMP instead of $HOME by @mre in #338
• Bump actions/checkout from 6 to 7 by @dependabot in #339
• Bump actions/cache from 5 to 6 by @dependabot in #340

Full Changelog: v2.8.0...v2.9.0

v2.8.0

What's Changed

• Update lycheeVersion to v0.23.0 by @github-actions[bot] in #324
• Update args for lychee-action to use root-dir by @mre in #314
• Update test to use --root-dir instead of the deprecated --base by @mre in #315
• Bump actions/checkout from 5 to 6 by @dependabot[bot] in #316
• Bump actions/cache from 4 to 5 by @dependabot[bot] in #319
• Bump peter-evans/create-pull-request from 7 to 8 by @dependabot[bot] in #318
• Add message with Summary report URL by @atteggiani in #326

New Contributors

• @atteggiani made their first contribution in #326

Full Changelog: v2.7.0...v2.8.0

Version 2.7.0

Breaking changes

If you're using --base, you must now provide either a URL (with scheme) or an absolute local path. See lychee --help for more information. If you want to resolve root-relative links in local files, also see --root-dir.

What's Changed

• Bump peter-evans/create-issue-from-file from 5 to 6 by @dependabot[bot] in #307
• Upgrade checkout action from v4 to v5 by @jacobdalamb in #310
• Update lycheeVersion to v0.21.0 by @github-actions[bot] in #312
  See https://github.com/lycheeverse/lychee/releases/tag/lychee-v0.21.0 for the lychee changelog.

Full Changelog: v2...v2.7.0

Version 2.6.1

What's Changed

• Update lycheeVersion to v0.20.1 by @github-actions[bot] in #306, which contains a hotfix for #305.

Full Changelog: v2...v2.6.1

Version 2.6.0

What's Changed

• Update lychee version to v0.20.0 by @github-actions[bot] in #304
• Bump actions/checkout from 4 to 5 by @dependabot[bot] in #303

Full Changelog: v2...v2.6.0

Version 2.5.0

Summary

Most notably with this release the deprecated --exclude-mail flag was removed and the behavior of the --accept flag was updated. Previously, status codes such as 200 OK were always accepted. Now they are only accepted by default. This means providing the argument --accept 201 now rejects status code 200 OK.

What's Changed

• Update lycheeVersion to v0.19.1 by @github-actions[bot] in #300
• See the lychee changes here: https://github.com/lycheeverse/lychee/releases/tag/lychee-v0.19.1, https://github.com/lycheeverse/lychee/releases/tag/lychee-v0.19.0

Full Changelog: v2...v2.5.0

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