ci: add Chromatic workflow and clarify release cadence#737
Open
QuintonJason wants to merge 6 commits into
Open
ci: add Chromatic workflow and clarify release cadence#737QuintonJason wants to merge 6 commits into
QuintonJason wants to merge 6 commits into
Conversation
✅ Deploy Preview for pine-design-system ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
15 tasks
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
QuintonJason
force-pushed
the
ci/add-chromatic
branch
from
d92f854 to
92cf7e0
Compare
Wire up Chromatic visual regression on PR and push to main/next. The `@chromatic-com/storybook` addon was already configured in libs/core/.storybook/main.js but no CI workflow ran against it. Fork PRs are skipped because repository secrets are unavailable. A `CHROMATIC_PROJECT_TOKEN` secret must be added by maintainers. Also clarify (in CONTRIBUTING.md and schedule-release.yml comments) that releases today run manually via workflow_dispatch — there is no weekly cron yet — so contributors know where to look when they ask.
Document and apply the per-branch policy for visual regressions: - PRs use exitZeroOnChanges so the workflow stays green; Chromatic's own PR status check is what blocks merge when diffs are unapproved. This keeps unrelated required checks visible. - main (and by extension next via the workflow trigger) auto-accept visual diffs into the baseline so post-merge re-approval is not required for code that has already passed review.
Avoid failing PR checks until CHROMATIC_PROJECT_TOKEN is added to repo secrets.
Address Aikido supply-chain finding on floating third-party action tag.
QuintonJason
force-pushed
the
ci/add-chromatic
branch
from
fdb4338 to
fe44c28
Compare
Check out PR head SHA, use pinned npm setup composite, and auto-accept visual changes on both main and next.
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 3c4ba46. Configure here.
Move CHROMATIC_PROJECT_TOKEN check to a step-level gate because secrets are unavailable in job-level if expressions, and use picomatch extglob @(main|next) for autoAcceptChanges.
pixelflips
approved these changes
May 27, 2026
pixelflips
left a comment
pixelflips
left a comment
Member
There was a problem hiding this comment.
How do we see the results, and don't forget to add the token, otherwise LGTM! 👍🏼
prsimp
approved these changes
Jul 10, 2026
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
3 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.
Description
Two related changes:
Wire up Chromatic visual regression in CI. The
@chromatic-com/storybookaddon is already configured inlibs/core/.storybook/main.js, but no CI workflow ran against it — so visual regressions could ship undetected. This adds.github/workflows/chromatic.ymlthat builds doc-components → Stencil → Storybook, then publishes to Chromatic on PR and push tomain/next. Fork PRs are skipped because repository secrets are unavailable to them.Document the actual release cadence.
CONTRIBUTING.mdnow explains how Visual regression and Releases work, and the comment block at the top ofschedule-release.ymlis expanded to make clear that releases are manual / on-demand viaworkflow_dispatch(andworkflow_call) — there is no weekly cron yet. Contributors were sometimes asking when the next release would auto-cut; this answers that.Required maintainer action: add a
CHROMATIC_PROJECT_TOKENrepo secret (from the Pine Chromatic project) before merging. Without it the new workflow will fail at the publish step.Part of the design-system maturity push — closes the Level-4 "Visual regression testing" gap.
Fixes #(no-issue)
Type of change
How Has This Been Tested?
@chromatic-com/storybookis already installed atlibs/core/.storybook/main.js.CHROMATIC_PROJECT_TOKEN).This PR cannot be fully exercised until the maintainer adds the secret; the first run after merge will surface any environmental issues.
Test Configuration:
Checklist:
cc @Kajabi/dss-devs
Note
Low Risk
CI and documentation only; no application runtime, auth, or data-path changes. Requires adding CHROMATIC_PROJECT_TOKEN for the job to run.
Overview
Adds Chromatic visual regression to CI via a new workflow that runs on PRs and pushes to
main/next. It builds doc-components, Stencil, and static Storybook, then publishes fromlibs/corewhenCHROMATIC_PROJECT_TOKENis set; otherwise it skips gracefully. Fork PRs are excluded from secret use; chromaui/action is pinned by SHA; PR runs useexitZeroOnChangeswhilemain/nextuseautoAcceptChanges.CONTRIBUTING documents Chromatic setup (secret, fork behavior) and that releases are manual via
workflow_dispatch/workflow_call, not cron.schedule-release.ymlcomments are expanded to match that on-demand cadence and how to enable a future schedule.Reviewed by Cursor Bugbot for commit 119d545. Bugbot is set up for automated code reviews on this repo. Configure here.