TINYDOC-3514 - Add scheduled link checking to CI#4276
Draft
kemister85 wants to merge 1 commit into
Draft
Conversation
Add a weekly scheduled workflow that builds the full published site (all versions) and runs lychee to detect dead external links, opening a link-rot issue when any are found. - .github/workflows/link-check.yml: weekly cron + manual dispatch - .lychee.toml: checker config (resolves root-relative links via base_url, excludes the tiny.cloud family and localhost, accepts redirects and 429) - .lycheeignore: curated hosts that block automated checkers but resolve in a browser - package.json: check-links script for local use - .gitignore: ignore the local lychee cache and report output
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
1 participant
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.
Ticket: TINYDOC-3514
Adds automated external-link checking to the docs CI. This PR is layer 1 of 2 — the scheduled full-site scan that detects link rot across every published version. The PR-time check (validating links a PR changes) follows separately on the version branches (
tinymce/8,/7,/6,/5), since that is where.adoccontent changes land.What this adds
.github/workflows/link-check.yml— runs every Monday 06:00 UTC (plus manual dispatch). Builds the full production site (all versions viaantora-playbook.yml) and runs lychee over the built HTML. Opens alink-rotissue when dead links are found. Non-blocking by nature (scheduled, not a PR gate)..lychee.toml— checker config. Key behaviours, all validated locally against a full 4-version build:base_urlresolves root-relative links (site chrome,/roadmap/) against the live domain instead of erroring on them locally.tiny.cloudfamily — those are validated by our own build/deploy, and HTTP-checking them from CI would hammer production (a naive config produced 640k+ false errors from rate-limiting).429; treats only genuine failures (4xx/5xx / no-resolve) as broken..lycheeignore— curated hosts that block automated checkers (npmjs, codepen, etc.) but resolve fine in a browser; each verified by hand.package.json—check-linksscript for local runs..gitignore— ignores the local lychee cache and report output.Baseline
A full multi-version crawl currently surfaces ~12 genuinely dead links (the same rot found in the DOC-3513 audit:
archive.tinymce.com,curl.haxx.se,commonjs.org, Facebook oEmbed, etc.). Fixing those is separate content follow-up; the weekly issue will track them.Notes for review
mainbecause scheduled workflows only fire from the default branch — andmain's playbook already aggregates all versions, so one job covers 5/6/7/8.Opened as a draft for review before the version-branch PRs.