Skip to content

Releases: lycheeverse/lychee-action

Version 1.2.1

08 Feb 11:37
@mre mre
Compare
Choose a tag to compare

Fix evaluating glob patterns

Glob patterns were not properly evaluated for three reasons:

  1. Quotes around globs were not preserved. As a result, unquoted wildcards were evaluated by bash instead of lychee
  2. ** 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.
  3. 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

08 Dec 22:17
@mre mre
f76b841
Compare
Choose a tag to compare

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)

18 Nov 21:56
@mre mre
cb79c96
Compare
Choose a tag to compare

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

03 Nov 22:16
@mre mre
5d7c153
Compare
Choose a tag to compare

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

27 Sep 21:17
@mre mre
461548a
Compare
Choose a tag to compare
  • Pin lychee version to specific SHA. This avoids breaking changes when lychee@master gets updated. (See #19)

Version 1.0.8

21 Apr 12:10
@mre mre
f56bc7d
Compare
Choose a tag to compare

Version 1.0.7

12 Apr 15:24
@mre mre
842ca57
Compare
Choose a tag to compare

Assume HTML for URLs and paths without extension. (lycheeverse/lychee#213) Fixes lycheeverse/lychee#183

Version 1.0.6

17 Mar 15:40
@mre mre
e8f5f9c
Compare
Choose a tag to compare

Rename to Lychee Broken Link Checker

Version 1.0.5

16 Mar 12:08
@mre mre
b483e09
Compare
Choose a tag to compare

Fix error code propagation (see #20)

Version 1.0.4

12 Feb 17:10
@mre mre
e02bac8
Compare
Choose a tag to compare

Bugfixes concerning issue creation