Sourced from lycheeverse/lychee-action's releases.
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](lycheeverse/lychee-action#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, asfail: true
has been the default there for a while.- If you prefer the old behavior, explicitly set
fail
tofalse
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
- feat: change to use the full version tag with v-* prefix by
@kemingy
in lycheeverse/lychee-action#204- Add
failIfEmpty
argument (fixes #84) by@mre
in lycheeverse/lychee-action#86- Fail pipeline on error by default (fixes #71) by
@mre
in lycheeverse/lychee-action#85- Exit in case output is set in args and action input by
@mre
in lycheeverse/lychee-action#227- v1 will automatically use latest version by
@jacobdalamb
in lycheeverse/lychee-action#228- Remove unneeded text by
@jacobdalamb
in lycheeverse/lychee-action#229- Clarify README.md defaults by
@paddyroddy
in lycheeverse/lychee-action#230- Adjust for new asset naming scheme by
@dscho
in lycheeverse/lychee-action#234- Test various lychee versions by
@mre
in lycheeverse/lychee-action#235
... (truncated)
7cd0af4
Merge commit from fork8ad54d3
fix link762333c
Create SECURITY.md (#259)71a38a3
Document and use correct permissions in the GitHub workflows (#258)f141760
Fix a typos (#257)2bb2326
don't remove the lychee config file (#255)731bf1a
Fix variable name (#253)e360f3c
Bump lycheeverse/lychee-action from 1 to 2 (#252)f87f0a6
Update version to lycheeverse/lychee-action@v2
in docs7da8ec1
Test latest lychee version tag (#236)