Releases: lycheeverse/lychee-action
Releases · lycheeverse/lychee-action
Version 1.2.1
Fix evaluating glob patterns
Glob patterns were not properly evaluated for three reasons:
- Quotes around globs were not preserved. As a result, unquoted wildcards were evaluated by bash instead of lychee
**
patterns handled by the glob crate need to be prefixed with a separator, e.g../
. See code here and here. We should probably switch to globset at some point, which doesn't have that limitation.- The lychee command itself needs to be executed with
eval
to make it find links. Otherwise it interprets the input argument (${ARGS[@]}
) as a string and tries to find links within that string. (String input is supported by lychee). We want to interpret it as individual (whitespace-separated) arguments however. (Note that Github Actions doesn't support arrays as inputs, which prevents us from using array splitting.)
Recommended usage inside pipelines: Surround glob patterns with single quotes and prefix them with ./
.
- name: Link Checker
uses: lycheeverse/lychee-action@v1.1.1
with:
# Check all Markdown and HTML files
args: --verbose --no-progress './**/*.md' './**/*.html'
For more context, see #67 and #68.
The examples have been updated accordingly.
Version 1.2.0
New inputs
Input | Example | Description |
---|---|---|
format | json | Use json as output format (instead of markdown) |
output | /tmp/foo.json | Use different output filename |
fail | true | Fail action on broken links |
Full example config
- name: Link Checker
uses: lycheeverse/lychee-action@v1.2.0
with:
# Check all markdown and html files in repo (default)
args: --verbose --no-progress **/*.md **/*.html
# Use json as output format (instead of markdown)
format: json
# Use different output filename
output: /tmp/foo.txt
# Fail action on broken links
fail: true
v1.1.1: Update to lychee 0.8.1 (#59)
Update to lychee 0.8.1 with support for markdown output.
See https://github.com/lycheeverse/lychee/releases/tag/v0.8.1 for changelog.
Version 1.1.0
Update to lychee 0.8.0 with local file support and more.
See https://github.com/lycheeverse/lychee/releases/tag/v0.8.0 for changelog.
Version 1.0.9
- Pin lychee version to specific SHA. This avoids breaking changes when lychee@master gets updated. (See #19)
Version 1.0.8
Version 1.0.7
Assume HTML for URLs and paths without extension. (lycheeverse/lychee#213) Fixes lycheeverse/lychee#183
Version 1.0.6
Rename to Lychee Broken Link Checker
Version 1.0.5
Fix error code propagation (see #20)
Version 1.0.4
Bugfixes concerning issue creation