docs: add an advisory PR-time doc-integrity check to docs-ui-tests - #2991
Open
marcel-rbro wants to merge 1 commit into
Open
marcel-rbro wants to merge 1 commit into
marcel-rbro wants to merge 1 commit into
Conversation
Splits the workflow into two jobs so doc-side drift is caught in review instead of up to a week later. doc-integrity runs on pull requests touching sources/platform/** or docs-tests/**. It runs only the `integrity` project — static checks that each assertion's source_file and source_quote still resolve. No browser and no credentials, so it needs no Playwright install and works on fork PRs, where secrets are unavailable. The check is informative only: `continue-on-error` keeps a failure from blocking the merge, and findings are written to the job summary as a table of assertion IDs and their doc sources, so a reviewer sees them without opening logs. Promoting it to a gate later means removing `continue-on-error` and marking it required in branch protection. ui-drift is unchanged except for an `if` guard keeping it off pull requests. It still runs weekly and on demand, against staging, and still files a drift issue on failure. The motivation is #2951: #2919 moved account/settings.md on 09-01, the baseline went stale, and nothing surfaced it until the scheduled run on 09-07 — into an unassigned issue that sat another 10 days. Run against that state locally, this job reports all 16 stale back-references in 4.3 seconds with no browser and no credentials. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FSj1mTUbMKgmu2JoGJLSKD
marcel-rbro
added
documentation
6 tasks
apify-service-account
added
the
tested
Contributor
|
✅ Preview for this PR (commit |
Contributor
|
I spy with my little 👀 a red PR check? |
This branch has not been deployed
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
3 participants
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.
Part of #2671. Addresses the cause behind #2988.
The harness only ran weekly, so #2919 moved a doc on 09-01 and nothing surfaced it until 09-07 — into an unassigned issue that then sat 10 days.
Splits the workflow into two jobs:
doc-integrity(new)sources/platform/**ordocs-tests/**source_file/source_quotestill resolvesui-drift(unchanged)Informative only:
continue-on-error: true, so a failure never blocks the merge. Findings render as a table in the job summary. Promoting it to a gate later means dropping that flag and marking the check required.No
playwright installand no secrets — the doc-side project never opens a browser, so it also works on fork PRs. Verified against the pre-#2988 state with no browser present: all 16 stale references reported in 4.3s.Note: this PR only touches
.github/workflows/, so the job won't self-trigger here. It first runs on the next docs PR after merge.🤖 Generated with Claude Code
https://claude.ai/code/session_01FSj1mTUbMKgmu2JoGJLSKD