actions-marketplace-validations/Publish to Chromatic

Publish your Storybook to Chromatic and run visual regression tests

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Feb 23, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: actions-marketplace-validations/chromaui_action@5ec258af08deb3e8c36653bd618cb7fe52090031 # no releases — HEAD as of 2026-07-13

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
autoAcceptChangesAutomatically accept all changes in chromatic: boolean or branchnameno
branchNameOverride the branch nameno
buildScriptNameThe npm script that builds your Storybook [build-storybook]no
buildCommandThe command that builds your Storybook (when your build command does not exist in "scripts" of your package.json)no
chromaticShaThe git SHA of the commit that should be tested in Chromatic. Defaults to the SHA of the current branch tip on which the action is running. Use with caution, as it may yield unexpected results.no
configFilePath from where to load the Chromatic config JSON file.
cypressRun build against `@chromatic-com/cypress` test archivesno
debugOutput verbose debugging informationno
diagnosticsFileWrite process context information to a JSON fileno
dryRunRun without actually publishing to Chromaticno
exitOnceUploadedExit with 0 once the built version has been sent to chromatic: boolean or branchnameno
exitZeroOnChangesPositive exit of action even when there are changes: boolean or branchnameno
externalsDisable TurboSnap when any of these files have changed since the baseline buildno
fileHashingWhether to apply file hashing to skip uploading unchanged files (default: true)no
forceRebuildDo not skip build when a rebuild is detectedno
ignoreLastBuildOnBranchDo not use the last build on this branch as a baseline if it is no longer in history (i.e. branch was rebased)no
logFileWrite CLI logs to a fileno
logLevelOne of: silent, error, warn, info, debug (default: info)no
logPrefixCustom prefix for log messages (default: current timestamp)no
onlyChangedEnables TurboSnap: Only run stories affected by files changed since the baseline buildno
onlyStoryNamesOnly run a single story or a subset of stories by their nameno
onlyStoryFilesOnly run a single story or a subset of stories by their filename(s)no
outputDirRelative path to target directory containing your Storybook (a temporary directory is used if this is not set)no
playwrightRun build against `@chromatic-com/playwright` test archivesno
preserveMissingDeprecated, use onlyChanged, onlyStoryNames or onlyStoryFiles insteadno
projectTokenYour chromatic project token (best provided via env.CHROMATIC_PROJECT_TOKEN)no
repositorySlugOverride the repository slug (e.g. ownerName/repositoryName)no
skipSkip Chromatic tests, but mark the commit as passingno
skipUpdateCheckSkips Chromatic CLI update checkno
storybookBaseDirRelative path from repository root to Storybook project rootno
storybookBuildDirProvide a directory with your built storybook; use if you have already built your storybookno
storybookConfigDirRelative path from where you run Chromatic to your Storybook config directoryno
storybookLogFileWrite Storybook build logs to a fileno
tokenYour github tokenno
traceChangedPrint dependency trace for changed files to affected story files; set to "expanded" to list individual modulesno
untracedDisregard these files and their dependencies when tracing dependent stories for TurboSnapno
uploadMetadataUpload Chromatic metadata files as part of the published Storybookno
workingDirWorking directory for the package.json fileno
zipPublish your Storybook to Chromatic as a single zip file instead of individual content filesno
junitReportWrite build results to a JUnit XML fileno
namedescription
codeThe exit code for the current run of the Chromatic CLI
urlAn alias for the build URL (e.g. https://www.chromatic.com/build?appId=<app id goes here>&number=<build number>)
buildUrlThe build URL (e.g. https://www.chromatic.com/build?appId=<app id goes here>&number=<build number>)
storybookUrlThe Storybook preview URL for your current branch / Pull Request (e.g. https://<app id goes here>-<branch hash>.chromatic.com/)
specCountThe number of stories in the published Storybook
componentCountThe number of components in the published Storybook
testCountThe number of tests on the build
changeCountThe number of tests with visual changes, including any inherited changes (e.g. due to TurboSnap)
errorCountThe number of tests with error(s), including any inherited errors (e.g. due to TurboSnap)
interactionTestFailuresCountThe number of stories with interaction test failures
actualCaptureCountThe number of captured snapshots
inheritedCaptureCountThe number of inherited (not captured) snapshots (e.g. due to TurboSnap)