lychee-action

Github action to check for broken links in Markdown, HTML, and text files using lychee, a fast link checker written in Rust.

APACHE-2.0 License

Stars
259
Committers
30

Bot releases are hidden (Show)

lychee-action - Version 2.0.1

Published by mre 7 days ago

What's Changed

New Contributors

Full Changelog: https://github.com/lycheeverse/lychee-action/compare/v2...v2.0.1

lychee-action - Version 2.0.0

Published by mre 11 days ago

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

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

lychee-action - v1.10.0 Latest Release

Published by mre 6 months ago

What's Changed

New Contributors

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

lychee-action - Version 1.9.3

Published by mre 9 months ago

What's Changed

  • Bugfix: Pass custom token as input argument to action by @mre in https://github.com/lycheeverse/lychee-action/pull/222
    Previously, the name of the token was incorrect, leading to no token being used if the user specified with: [token: ...].
    Thanks to @tobon4 for pointing this out.

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

lychee-action - Version 1.9.2

Published by mre 9 months ago

What's Changed

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

lychee-action - Version 1.9.1

Published by mre 9 months ago

This is a hotfix release which restores the behavior of the accept config parameter.
Integers are accepted again as status codes.

accept = [200, 201, 202, 203, 429]

is equivalent to

accept = ["200..=203", 429]

Integers and strings (e.g. for ranges) can be mixed.

lychee-action - Version 1.9.0

Published by mre 10 months ago

What's Changed

New Contributors

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

lychee-action - Version 1.8.0

Published by mre over 1 year ago

What's Changed

  • Update lychee to 0.13.0.
  • Adds support for showing the check duration in the JSON output.
  • Faster link suggestions by using concurrent Wayback Machine lookups.

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

lychee-action - Version 1.7.0

Published by mre over 1 year ago

What's Changed

New Contributors

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

lychee-action - Version 1.6.1

Published by mre over 1 year ago

Summary

Hotfix release, which restores old behavior for cached links with status code 2xx.
This temporarily broke some downstream pipelines.

What's Changed

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

lychee-action - Version 1.6.0

Published by mre over 1 year ago

What's Changed

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

lychee-action - Version 1.5.4

Published by mre almost 2 years ago

What's Changed

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

lychee-action - Version 1.5.3

Published by mre almost 2 years ago

What's Changed

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

lychee-action - Version 1.5.2

Published by mre almost 2 years ago

What's Changed

New Contributors

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

lychee-action - Version 1.5.1

Published by mre about 2 years ago

Summary

Bump lychee version to fix some regressions and extend the documentation.

What's Changed

New Contributors

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

lychee-action - Version 1.5.0

Published by mre over 2 years ago

Major Changes

  • Run action without Docker for a ~40% performance improvement (#121) @mre
  • Bump lychee to v0.10.0 (#130) @mre
  • Add support for Github Job Summaries (#127) @mre
  • Only append markdown if format isn't JSON (#101) @flcdrg
  • Fix condition in README (#102) @mbg
  • Bump peter-evans/create-issue-from-file from 3 to 4 (#98)
  • Update link to dependabot config @mre
  • Update links.yml @mre
  • Deep link to lychee commandline parameters @mre

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

Thanks to all the testers, contributors, and maintainers for improving lychee-action! ❤️

lychee-action - Version 1.4.1

Published by mre over 2 years ago

Bugfix: update to latest lychee 0.9.0 Docker image tag

Due to a race condition in the pipeline, we pushed an older version of lychee (0.8.2) to the 0.9.0 tag.
The new release binaries didn't exist yet, causing the binary to use old ones.
This is fixed now and the image got pushed again. Update the image sha accordingly.

lychee-action - Version 1.4.0

Published by mre over 2 years ago

Update to lychee 0.9.0. See highlights here.

lychee-action - Version 1.3.2

Published by mre over 2 years ago

Create an output file even if lychee panics (see https://github.com/lycheeverse/lychee-action/issues/82).

lychee-action - Version 1.3.1

Published by mre over 2 years ago

Bugfix: Use > as redirect operator for output files (#77). Thanks to @vipulgupta2048.

Package Rankings
Top 0.93% on Github actions
Badges
Extracted from project README
GitHub Marketplace Check Links Check Links
Related Projects