Skip to content

chore(ci): Fix offline link check #923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lwasser merged 2 commits into from
Sep 18, 2025
Merged

chore(ci): Fix offline link check #923

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
075ceef
ci: correct workflow file format
JimMadge Sep 16, 2025
8d0ce24
ci: add root directory to offline link check
JimMadge Sep 16, 2025
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
13 changes: 7 additions & 6 deletions .github/workflows/offline-link-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ jobs:
link_check:
runs-on: ubuntu-latest
steps:
uses: actions/checkout@v5
uses: lycheeverse/lychee-action@v2
# Only check local files, no network requests
args: --offline --no-progress 'src/content/docs/**/*.md'
# Fail job when lychee returns a non-zero exit code
fail: true
- uses: actions/checkout@v5
- uses: lycheeverse/lychee-action@v2
with:
# Only check local files, no network requests
args: --config './lychee.toml' --no-progress --offline --root-dir "$GITHUB_WORKSPACE/public/" 'src/content/docs/**/*.md'
Copy link
Member

@lwasser lwasser Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JimMadge i think you are fixing something that's been bugging us at pyOpenSci for a while. Every time we add a new page to our site, lychee breaks. So this forces lychee to check links "internally" vs online . is that correct?

Thank you for this!!

Copy link
Member Author

@JimMadge JimMadge Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, the --offline flag means Lychee will only check links to local files (and maybe local network, not sure 😅).

So, I've found it useful for CI. You can check all of the internal links in your built HTML work, but you don't block PRs because of false positives when checking sites over the internet.

# Fail job when lychee returns a non-zero exit code
fail: true