Document design system dependency management and verify safeguards#965
Closed
Document design system dependency management and verify safeguards#965
Conversation
- Document current version pinning strategy (exact versions) - Document automated update workflow with test gates - Verify workflow successfully caught breaking change in 3.39.2 - Identify 10 instances of deprecated asChild prop across 5 files - Add clarifying comments to workflow about expected failures - Provide recommendations for semver adherence upstream Context: Addresses concerns from #team-eng Slack thread about design system updates breaking docs. Analysis shows current safeguards are working correctly - the breaking change was caught and prevented from merging. Co-authored-by: Francisco Or Something <fjlimal@gmail.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Overview
This PR documents the current design system dependency management strategy and verifies that existing safeguards are working correctly.
Analysis Summary
✅ Current Safeguards Are Working
The docs repo already has effective safeguards in place:
3.39.1(not^3.39.1)🛡️ Breaking Change Was Caught
On May 6, 2026, the automated workflow successfully prevented a breaking change:
asChildprop from Button component📊 Impact Assessment
If we were to upgrade to 3.39.2, these files would need updates:
app/not-found.tsx(1 usage)app/en/resources/integrations/components/filters-bar.tsx(3 usages)app/_components/glossary-term.tsx(1 usage)app/_components/challenge-solution.tsx(1 usage)app/en/home/landing-page.tsx(4 usages)Total: 10 instances of
asChildprop across 5 filesChanges in This PR
1. Added Analysis Document
Created
DESIGN_SYSTEM_DEPENDENCY_ANALYSIS.mddocumenting:2. Enhanced Workflow Clarity
Updated
.github/workflows/update-design-system-dependency.ymlwith clarifying comments explaining that test failures are expected behavior when breaking changes are detected.Recommendations
For Docs Repo (This Repo)
✅ Keep current approach - No changes needed. The system is working correctly.
For Design System Repo (Upstream)
The root issue is upstream semver adherence:
asChildprop is a breaking change4.0.0, not3.39.2For Process
When the automated workflow fails:
Questions Addressed
Already implemented: The workflow includes a full production build before creating PRs.
Answer: Yes, we are pinning to exact version
3.39.1. This is correct.Agreed: The upstream design system repo should follow semver more strictly.
Conclusion
The concerns raised were already addressed by existing safeguards. The workflow correctly caught and prevented a breaking change from being merged. This PR adds documentation to make the current system more transparent and provides recommendations for upstream improvements.
Related:
3.39.2(blocked by breaking changes)3.39.1(stable)Slack Thread