Skip to content

fix(ci): catch broken toc.json entries on every PR and after merges - #856

Merged
ChronosSF merged 3 commits into
vnextfrom
dtsvetkov/toc-check-gaps
Sep 25, 2026
Merged

ChronosSF merged 3 commits into
vnextfrom
dtsvetkov/toc-check-gaps

Conversation

@dobromirts

Copy link
Copy Markdown
Contributor

Closes #518

Changes

  • check-relative-links.yml: removed the paths filter so toc.json-only PRs are checked too, and added a push trigger for master/vnext so the branch is re-checked after merges.
  • sidebar.ts: buildSidebarFromToc() now warns about each toc entry it drops because the target file is missing (it used to drop them silently). With DOCS_TOC_STRICT=true it fails the build instead.
  • ci.yml: sets DOCS_TOC_STRICT=true for the builds, so a missing target fails build-and-verify. Deploy builds only warn.

Follow-up

To actually block merging, an admin needs to add check-relative-links as a required status check in the "vnext & master" ruleset.

@dobromirts dobromirts added the ❌ status: awaiting-test PRs awaiting manual verification label Sep 25, 2026
@dobromirts

Copy link
Copy Markdown
Contributor Author

@ChronosSF once this is merged, could you make check-relative-links a required status check?

@ChronosSF ChronosSF added 💥 status: in-test PRs currently being tested and removed ❌ status: awaiting-test PRs awaiting manual verification labels Sep 25, 2026
@ChronosSF ChronosSF added ✅ status: verified Applies to PRs that have passed manual verification and removed 💥 status: in-test PRs currently being tested labels Sep 25, 2026
@ChronosSF
ChronosSF merged commit 4fafaf4 into vnext Sep 25, 2026
8 checks passed
@ChronosSF
ChronosSF deleted the dtsvetkov/toc-check-gaps branch September 25, 2026 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

✅ status: verified Applies to PRs that have passed manual verification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken toc.json links can slip through CI

2 participants