Skip to content

ci: add Lychee link checker to docs build workflow#857

Closed
Copilot wants to merge 2 commits intodocs/check-linksfrom
copilot/sub-pr-854
Closed

ci: add Lychee link checker to docs build workflow#857
Copilot wants to merge 2 commits intodocs/check-linksfrom
copilot/sub-pr-854

Conversation

Copy link
Contributor

Copilot AI commented Mar 2, 2026

Adds an automated broken link check to the docs CI job using Lychee. On each PR, after the docs are built, Lychee scans the generated HTML and posts/updates a PR comment if broken links are detected.

Changes

  • .github/workflows/check.yaml: Appends three steps to the existing docs job:
    • Run Lychee against ./website/build/**/*.html (non-blocking, fail: false)
    • Find any existing broken-links comment on the PR
    • Create or update that comment — green ✅ if all links pass, warning ⚠️ if any are broken

Docs link fixes are intentionally excluded from this PR and will be addressed separately.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@barjin
Copy link
Member

barjin commented Mar 2, 2026

@copilot point this PR to master (only the CI changes)

Co-authored-by: barjin <61918049+barjin@users.noreply.github.com>
Copilot AI changed the title [WIP] Add link checker action for new PRs using Lychee ci: add Lychee link checker to docs build workflow Mar 2, 2026
Copy link
Contributor Author

Copilot AI commented Mar 2, 2026

@copilot point this PR to master (only the CI changes)

I can't change the base branch of a PR directly — that requires the GitHub UI or API. Could you use the "Edit" button on the PR to change the base from docs/check-links to master? The branch already only differs from master by the CI check in .github/workflows/check.yaml, so no code changes are needed.

@barjin barjin closed this Mar 2, 2026
@barjin barjin deleted the copilot/sub-pr-854 branch March 2, 2026 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants