Fix diagram anchor check false positives (EDUENG-677)#23185
Open
ebembi-crdb wants to merge 1 commit intomainfrom
Open
Fix diagram anchor check false positives (EDUENG-677)#23185ebembi-crdb wants to merge 1 commit intomainfrom
ebembi-crdb wants to merge 1 commit intomainfrom
Conversation
Two fixes to eliminate false failures on PRs touching SQL pages with diagrams: 1. Collect <a name="..."> attributes in addition to id= attributes. stmt_block.html defines all ~800 anchors using <a name="...">, not id=, so the script was finding 0 anchors and reporting every reference as broken. 2. Also check stub anchors defined in sql-grammar.md. These files define stub anchors (e.g. col_label) for missing nonterminals that diagrams reference but that don't exist in stmt_block.html.
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
Files changed:
|
✅ Deploy Preview for cockroachdb-docs canceled.
|
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.
Summary
<a name="...">anchors in_IDCollector, not justid=attributes.stmt_block.htmldefines all ~800 anchors via<a name="...">, so the check was finding 0 anchors and reporting every cross-page reference as broken.sql-grammar.mdalongsidestmt_block.html. The grammar pages define stub anchors (e.g.col_label,column_constraints) for nonterminals that diagrams reference but that don't exist instmt_block.html.stmt_block.htmlandsql-grammar.md.Fixes false failures on PRs like #23181 (RESTORE docs), which reported 6 "broken" anchors that actually resolve correctly on the rendered site.
Test plan
python3 .github/scripts/validate_diagram_anchors.py src/current/v26.2/restore.md— passes (0 broken anchors, was 6 false positives before)GITHUB_TOKENset