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, 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.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps lycheeverse/lychee-action from 1 to 2.
Release notes
Sourced from lycheeverse/lychee-action's releases.
... (truncated)
Commits
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 tolycheeverse/lychee-action@v2
in docs7da8ec1
Test latest lychee version tag (#236)6cba5a9
Bump version to 0.16.x, respect new tag names (#249)e71a9a1
Split up steps in action (#248)897f08a
action.yml: fix failing CI (#246)22c8e46
Set exit_code correctly as output (#245)5047c2a
README: update actions/cache to v4 (#243)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show