Skip to content

ci: fail when a citation into the threadbase umbrella stops resolving - #663

Merged
RonenMars merged 1 commit into
mainfrom
docs/umbrella-link-check
Aug 20, 2026
Merged

ci: fail when a citation into the threadbase umbrella stops resolving#663
RonenMars merged 1 commit into
mainfrom
docs/umbrella-link-check

Conversation

@RonenMars

Copy link
Copy Markdown
Owner

Canonical conventions now live in the umbrella repo and this repo cites them as plain URLs — the "A" half of the approach agreed in #660.

A URL has exactly one real weakness: a rename in the umbrella breaks every citation here silently.
Nothing in a markdown file 404-checks itself, and no pull request in this repo is involved when it happens, so the break can sit indefinitely.

The check

Resolves every https://github.com/RonenMars/threadbase/blob/main/… link found in the tree.
Runs on pull requests touching markdown, and weekly on a schedule — the schedule is the half that matters, since the break arrives from the other repo.

An empty match set fails rather than passes. Zero links means the matcher stopped matching, not that the citations are healthy. If the last citation is ever genuinely removed, the workflow should be deleted with it.

Verified before landing

All three directions, run locally against this tree:

Case Result
Four real links 200 each, job passes
Fabricated docs/this-does-not-exist.md 404, job fails
Tree with no umbrella links fails loudly with "the matcher is broken"

Also

Cites integration-branch-lifecycle.md from the integration-branch skill — in the expiry section, and beside the ref audit whose script it now holds.
That is the citation I had to strip when the document existed only in tb-mobile.

No [skip-ci]: this adds workflow YAML, so it is not a docs-only change and wants the full matrix.

Reference: #660, RonenMars/threadbase#6, RonenMars/threadbase-mobile#796.

Canonical conventions now live in the umbrella repo and this repo cites them as plain URLs.
A rename there breaks every citation here silently, because nothing in a markdown file 404-checks itself and no pull request in this repo is involved.

Adds a workflow that resolves every https://github.com/RonenMars/threadbase/blob/main/ link found in the tree, on pull requests touching markdown and on a weekly schedule.
The schedule is the half that matters: the break arrives from the other repo.

An empty match set fails rather than passes, because zero links means the matcher stopped matching, not that the citations are healthy.
Verified against all three cases before landing: four real links resolve, a fabricated path returns 404 and fails the job, and an empty tree fails loudly.

Cites the new lifecycle document from the integration-branch skill, in the expiry section and beside the ref audit it describes.
@RonenMars
RonenMars merged commit f927c88 into main Aug 20, 2026
11 checks passed
@RonenMars
RonenMars deleted the docs/umbrella-link-check branch August 20, 2026 10:59
@RonenMars

Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 1.67.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

RonenMars added a commit that referenced this pull request Sep 3, 2026
…#663)

Canonical conventions live in the umbrella repo and this repo cites them as plain URLs, so a rename there breaks every citation here silently.
Adds a workflow resolving every umbrella link in the tree, on pull requests touching markdown and weekly on a schedule.
An empty match set fails rather than passes, because zero links means the matcher stopped matching rather than the citations being healthy.
Cites the lifecycle document from the integration-branch skill, in the expiry section and beside the ref audit it describes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant