Repository navigation
ci(check-links): widen lychee's inputs to docs/** and the root history pages - #26313
Merged
Merged
Conversation
…y pages Add 'docs/**/*.md' (with docs/adr/ excluded via --exclude-path, since the Check ADR cross-links step owns that registry) and CHANGELOG.md, RELEASE_NOTES.md, CONTRIBUTING.md, ROADMAP.md, LICENSING.md and CODE_OF_CONDUCT.md to the job's LYCHEE_ARGS. Fix the six dead links the widened run reported on origin/main: two targets that moved (the formula guide, the driver-memory changelog) now point at their new paths; four whose targets were deleted on purpose (plugin-org-scoping's README, REMOTE_API_COMMANDS.md, the internal roadmap and the quick-start doc) lose the link or the sentence. Claude-Session: https://claude.ai/code/session_019PqtBRVkBPJHnCXGWvUQED Co-authored-by: Claude <noreply@anthropic.com>
Contributor
Author
席位核对 · ACCEPT · devx seat 2 · 2026-10-26T20:23ZSeat
Generated by Claude Code |
os-zhuang
approved these changes
Oct 26, 2026
os-zhuang
marked this pull request as ready for review
October 26, 2026 22:46
os-zhuang
enabled auto-merge
October 26, 2026 22:47
This was referenced Oct 27, 2026
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.
Requested by Steve · project thread
Fixes #26087
Clause-②: no
Metadata-protocol: none
What
check-links.ymlhanded lychee onlycontent/**,README.mdandARCHITECTURE.md, so a dead relative link anywhere indocs/or in the root history pages was checked by nothing. This PR widens the same job's input (no new workflow, no new gate, no path filter) and fixes every link the wider run reports.LYCHEE_ARGSgains'docs/**/*.md',CHANGELOG.md,RELEASE_NOTES.md,CONTRIBUTING.md,ROADMAP.md,LICENSING.md,CODE_OF_CONDUCT.md.docs/adr/is taken back out with--exclude-path '^docs/adr/': theCheck ADR cross-linksstep in the same job owns that registry, with its own shrink-only baseline, so one link gets one verdict. The workflow's comment above the argv is rewritten to say that (it previously justified the exclusion by "8 broken ADR links today", which no longer holds, see Acceptance notes).AGENTS.mdis not added and not edited (other cards hold it). Measured separately: its 2 links resolve, 0 errors.lychee.tomlis unchanged.Link fixes (6)
CHANGELOG.md(org-scoping entry)packages/plugins/plugin-org-scoping/README.mdCHANGELOG.md(M9 formula entry)content/docs/guides/formula.mdxcontent/docs/data-modeling/formulas.mdx(f7606a1)CHANGELOG.md(remote API commands entry)./REMOTE_API_COMMANDS.mdRELEASE_NOTES.md(v0.2.0 package list)packages/plugins/driver-memory/CHANGELOG.mdpackages/drivers/driver-memory/(06ba036)RELEASE_NOTES.md(v0.2.0 docs list)internal/planning/DEVELOPMENT_ROADMAP.mdRELEASE_NOTES.md(v0.2.0 docs list)QUICK_START_IMPLEMENTATION.mdDeleted-on-purpose targets lose the sentence; nothing is pointed at a different document. Two moves (same content, new path) get the new path. The card's sampled
docs/NEXT_STEP.mdanddocs/releases-maintenance.mdlinks are already gone onmain(#26271, #26021):docs/**reports 0 errors before this PR.Acceptance
lychee 0.24.2 (the pinned version, built from crates.io in the card container), CI's argv read out of the workflow YAML with
github.workspacesubstituted, cache file removed before each run, tree =origin/main69aa630 for "before" and fceddfe for "after":docs/adr/excludedCHANGELOG.md, 3 inRELEASE_NOTES.md, 0 indocs/**docs/adr/excluded--exclude-path '^docs/adr/'drops everydocs/adr/input and nothing else, andlychee.toml's ownexclude_path(meta.json) keeps applying alongside it (--dump-inputswith and without the flag).docs/HARDENING.md,ROADMAP.mdand an ADR → exit 2 with exactly 2 errors (thedocs/andROADMAP.mdones; the ADR one is not read). Restored fromHEAD,git diff HEADempty.Check Linksrun is the after reading.node scripts/check-adr-links.mjs --self-test && node scripts/check-adr-links.mjs→ exit 0, 807 destinations resolve.pnpm check:doc-authoring→ exit 0.Gates
node scripts/pm/dispatch-gates.mjs --commands --repo objectstack-ai/objectstackon fceddfe derived 37 commands; all 37 ran locally with stdin from/dev/null, every exit 0 (incl.pnpm check:pm-dispatch-gates, fast tier, 243 s).--ranreconciliation: 37 derived, 37 run, 0 NOT-MEASURED (a derived zero). Every other family is CI's, read from this PR's check-runs.Acceptance notes
docs/adr/**would report 8 broken links; measured today it reports 0 (the widened run with no exclusion: 4217 total, the same 6 errors, none underdocs/adr/), andcheck-adr-links.mjs'sKNOWN_DEAD_TARGETSis empty. The exclusion is kept on ownership grounds, not on rot.scripts/check-adr-links.mjs's header still says lychee runs "exactly three globs"; that prose is now stale (observation only; outside this card's file surface).docs/NORTH-STAR.mdis insidedocs/**and is a governed file; it reports 0 errors, so the widened glob reads it but this PR does not edit it.Changeset
None: the diff touches a workflow and two root history files, which no package publishes.
skip-changesetis set at creation.维护者速读(草稿)
改了什么:链接检查原来只看
content/、README 和 ARCHITECTURE,现在同一个任务也检查docs/下的文档(ADR 除外,ADR 已有自己的检查)和 6 个根目录文档(CHANGELOG、RELEASE_NOTES、CONTRIBUTING、ROADMAP、LICENSING、CODE_OF_CONDUCT)。顺手修掉扩大范围后查出的 6 个坏链,都在 CHANGELOG 和 RELEASE_NOTES 的历史条目里。为什么改:读者从发布说明或路线图点链接会落到 404,而本该发现它的检查从来没看过这些文件。
风险与代价(含回滚):这条检查是建议性的,不在必过集合里,不会挡合并。用时几乎不变(lychee 本身多几十毫秒)。将来有人在
docs/或这些根文件里写坏链,这条检查会变红。回滚就是撤掉check-links.yml里新增的几行。席位意见:
你要做的:这是受管文件(
.github/workflows/)的改动,需要你审批后才能落地。PR 保持 draft,席位不会自己转 ready 或开自动合并。Generated by Claude Code