Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/basic-qa.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ jobs:
- name: Link Checker
uses: lycheeverse/lychee-action@v2
with:
args: --cache --max-cache-age 1w --verbose "./**/*.md"
# Sidebar file exclusion is needed to work-around an upstream bug.
# Should be removed once bug https://github.com/lycheeverse/lychee/issues/1788 has been fixed.
args: --cache --max-cache-age 1w --verbose "./**/*.md" --exclude-path ./wiki/_Sidebar.md
format: markdown
token: ${{ secrets.GITHUB_TOKEN }}
fail: true
Expand Down
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,7 @@ To run the quality checks locally, install the following tooling:
* Run it like so: `markdownlint-cli2`
* [Lychee](https://github.com/lycheeverse/lychee)
* [Installation instructions](https://github.com/lycheeverse/lychee?tab=readme-ov-file#installation)
* Run it like so: `lychee "./**/*.md"`
Note: this command will show "false positives" locally for the `_Sidebar.md` file. These can be ignored.
* Run it like so: `lychee "./**/*.md" --exclude-path ./wiki/_Sidebar.md`
* [CSpell](https://cspell.org/)
* [Installation instructions](https://cspell.org/docs/installation)
* Run it like so: `cspell "**/*.md"`
Expand Down
Loading