Repository navigation
fix(ci): shard scoped e2e runs to avoid snapshot timeouts - #8236
Conversation
|
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughScoped E2E runs now execute across two containers instead of one. The workflow comment documents that scoped runs include the global ChangesScoped E2E execution
Priority: ➖ Normal Estimated code review effort: 1 (Trivial) | ~3 minutes Severity of issue fixed: Medium Suggested reviewers: Merge Risk: ⚪ Minimal · up to Scoped E2E runs will distribute the global Markdown snapshot workload across two shards, reducing timeout risk while retaining the existing test coverage and workflow behavior. No current merge-blocking risk remains. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
@mermaid-js/examples
mermaid
@mermaid-js/layout-elk
@mermaid-js/layout-tidy-tree
@mermaid-js/mermaid-zenuml
@mermaid-js/parser
@mermaid-js/tiny
commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #8236 +/- ##
==========================================
Coverage 80.73% 80.73%
==========================================
Files 619 619
Lines 84970 84970
Branches 16091 18596 +2505
==========================================
Hits 68601 68601
Misses 15350 15350
Partials 1019 1019
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
|
Hi @Raj4478, [sisyphos-bot] 🎉 [praise] The rebase made this a clean, minimal fix. The 4-line change (E2E_SCOPED_MATRIX: '[1]' → [1,2] plus an updated comment) now correctly targets the infrastructure that's in develop: the 🎉 [praise] The sharding mechanics are sound end-to-end:
🎉 [praise] The PR description's validation is thorough and matches the actual workflow — 11 scoping scenarios, 614+614 shard partitioning, artifact naming. The author clearly understands the Security No security issues. This is a CI env var value change only. All run: steps use Self-Check
|
|
@Raj4478, Thank you for the contribution! |
Develop picked up mermaid-js#8236 (shard scoped e2e runs across two containers), which fixes the 30-minute timeout that has been cancelling the scoped e2e job on diagram-scoped PRs like this one. No source changes — only .github/workflows/e2e.yml — so the parser and specs are untouched from the previously verified state (lint:jison clean, sequence suite 148/148).
…-e2e fix(ci): shard scoped e2e runs to avoid snapshot timeouts
Develop picked up mermaid-js#8236 (shard scoped e2e runs across two containers), which fixes the 30-minute timeout that has been cancelling the scoped e2e job on diagram-scoped PRs like this one. No source changes — only .github/workflows/e2e.yml — so the parser and specs are untouched from the previously verified state (lint:jison clean, sequence suite 148/148).
📑 Summary
Scoped diagram changes still include the global Markdown snapshot runner. With a single CI shard, that work is close to the 30-minute job limit; #8235 documents three timed-out runs on unrelated contributions.
Run scoped E2E jobs on two shards and update the nearby comment to explain why. This distributes the snapshot workload using the workflow's existing sharding support.
Resolves #8235
📏 Design Decisions
strategy.job-total, andfullyParallel: trueallows the single snapshot spec to be split between workers.screenshots-*withmerge-multiple: trueand waits for the complete E2E matrix to succeed.Validation
scripts/e2e-diagram-scope.mjsin temporary Git repositories. Before the change, five scoped entry paths selected one shard; afterwards, all 11 checked scenarios passed: diagram changes, fixture-only changes, diagram plus docs, merge queue, manual scoped/full runs, shared-renderer changes, workflow changes, the kill switch, direct develop pushes, and docs-only skipping.--listmode on a registration-only suite built from the current 1,228 Markdown fixture paths, preserving the snapshot runner's nested suites and parallel setting. The two shards contain 614 + 614 tests, with zero overlap and zero omissions. This verifies scheduling, not diagram rendering.git diff --checkpassed.📋 Tasks
Summary
mmd-snapshotsworkload while retaining the full selected test set and 30-minute job limit..github/workflows/e2e.yml.Validation