ci(docs): add mermaid render lint to prevent diagram syntax regressions - #240
Closed
yeongseon wants to merge 1 commit into
Closed
ci(docs): add mermaid render lint to prevent diagram syntax regressions#240yeongseon wants to merge 1 commit into
yeongseon wants to merge 1 commit into
Conversation
Add a PR-triggered workflow that renders every ```mermaid block in README*.md and docs/ with mermaid-cli (mmdc), failing fast when a diagram has invalid syntax. Runs only on PRs that touch README*/docs, keeping the chromium-based dependency isolated from the main test CI. Closes #214
Owner
Author
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
2 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.
Summary
Adds a
Mermaid Render Lintworkflow that renders every```mermaidblock inREADME*.mdanddocs/via@mermaid-js/mermaid-cli(mmdc), so invalid diagram syntax fails fast in CI. Follow-up from #209 (deferred to keep the chromium-based dependency isolated and reviewable).README*.md/docs/**(plusworkflow_dispatch), keeping the browser dependency out of the main test matrix.--no-sandboxPuppeteer config for headless Chromium on the runner.actions/checkoutandactions/setup-nodeto the same SHAs already used elsewhere in the repo.Verification
Ran the exact lint logic locally against this repo:
docs/architecture.md,README.md,README.ko.md,README.ja.md,README.zh-CN.md) render OK, exit 0.flowchartcorrectly fails with a non-zero exit.Closes #214