demo: showcase _stmt suffix handling in diagram automation#42
Open
ebembi-crdb wants to merge 2 commits into
Open
demo: showcase _stmt suffix handling in diagram automation#42ebembi-crdb wants to merge 2 commits into
ebembi-crdb wants to merge 2 commits into
Conversation
This demonstrates how the automation handles the _stmt suffix edge case: - The BNF file will be named show_statement_diagnostics_stmt.bnf - The HTML file will be show_statement_diagnostics.html (without _stmt) - This automatic handling prevents the naming conflicts mentioned in meeting notes
SQL Diagram Generation Report✅ Validation Passed 🔄 Diagram changes detected Changed Diagram Previewsshow_statement_diagnostics Showing 1 changed diagram(s). Only diagrams that differ from master are shown. SKIP DOC Warnings (click to expand)The following grammar rules are suppressed from documentation: This comment was generated by the SQL Diagram CI workflow. |
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.

Demo PR: _stmt Suffix Handling
This PR demonstrates how the automation correctly handles the naming conflict edge case mentioned in the meeting notes.
What this PR does:
show_statement_diagnostics_stmt_stmtsuffix to showcase the automationExpected automation behavior:
show_statement_diagnostics_stmt.bnf(with suffix)show_statement_diagnostics.html(WITHOUT suffix)Meeting notes reference:
From meeting notes line 21-22: When adding a new diagram, the statement suffix needs to be removed from corresponding Bazel file entries to prevent conflicts that cause HTML files not to update correctly.
The automation handles this automatically via lines 82-105 of .github/workflows/docgen-diagrams-ci.yml
Watch the automation in action:
Check the Actions tab to see the workflow automatically handling the suffix!