ci: add Lychee link checker for the docs#998
Draft
vdusek wants to merge 2 commits into
Draft
Conversation
Adds a daily (and manually dispatchable) Lychee workflow that builds the docs and checks the generated HTML for broken links, and flips onBrokenLinks/onBrokenMarkdownLinks to 'throw' so broken internal links fail the docs build. Mirrors the apify-docs setup.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #998 +/- ##
==========================================
- Coverage 90.54% 90.51% -0.04%
==========================================
Files 49 49
Lines 3132 3132
==========================================
- Hits 2836 2835 -1
- Misses 296 297 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Mirrors crawlee-python's scheduled-tests workflow: runs weekdays at 01:00 UTC (same as crawlee) and pings the team Slack channel via SLACK_WEBHOOK_URL when a scheduled run fails (skipped on manual dispatch). Renames lychee.yml to on_schedule_lychee.yaml to match the on_schedule_* convention.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a scheduled link checker for the docs, mirroring crawlee-python's scheduled-tests workflow. Three parts:
.github/workflows/on_schedule_lychee.yaml: runs on weekdays at 01:00 UTC (and on manualworkflow_dispatch), builds the docs withuv run poe build-docs, and runslycheeverse/lychee-actionover the generated./website/build/**/*.htmlto catch broken external links and runtime 404s. On a failed scheduled run it posts a Slack alert to the team channel viaSLACK_WEBHOOK_URL(skipped on manual dispatch, so ad-hoc triggers don't spam). It is not PR-blocking..lycheeignore: ignore patterns ported from apify-docs and retargeted to this repo.onBrokenLinks/onBrokenMarkdownLinks→throwindocusaurus.config.js: broken internal links now fail the docs build (anchors stay at the defaultwarn, same as apify-docs).The broken-link fixes this
throwpolicy depends on already landed in #997. Verified locally: fullpoe build-docswiththrowpasses (0 broken links).