Skip to content

Commit 808c80f

Browse files
committed
GH Actions: work around a bug in Lychee
Wiki links with spaces are incorrectly flagged as broken since Lychee 0.19.0. This has been reported upstream via lycheeverse/lychee 1788 For now, let's exclude the `_Sidebar.md` file from the scan to unblock contributors. This change should be undone once the upstream issue has been fixed & released.
1 parent 3b7a54f commit 808c80f

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

.github/workflows/basic-qa.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ jobs:
4242
- name: Link Checker
4343
uses: lycheeverse/lychee-action@v2
4444
with:
45-
args: --cache --max-cache-age 1w --verbose "./**/*.md"
45+
# Sidebar file exclusion is needed to work-around an upstream bug.
46+
# Should be removed once bug https://github.com/lycheeverse/lychee/issues/1788 has been fixed.
47+
args: --cache --max-cache-age 1w --verbose "./**/*.md" --exclude-path ./wiki/_Sidebar.md
4648
format: markdown
4749
token: ${{ secrets.GITHUB_TOKEN }}
4850
fail: true

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,7 @@ To run the quality checks locally, install the following tooling:
122122
* Run it like so: `markdownlint-cli2`
123123
* [Lychee](https://github.com/lycheeverse/lychee)
124124
* [Installation instructions](https://github.com/lycheeverse/lychee?tab=readme-ov-file#installation)
125-
* Run it like so: `lychee "./**/*.md"`
126-
Note: this command will show "false positives" locally for the `_Sidebar.md` file. These can be ignored.
125+
* Run it like so: `lychee "./**/*.md" --exclude-path ./wiki/_Sidebar.md`
127126
* [CSpell](https://cspell.org/)
128127
* [Installation instructions](https://cspell.org/docs/installation)
129128
* Run it like so: `cspell "**/*.md"`

0 commit comments

Comments
 (0)