drunkydog/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
Stale
License
None
Runtime
Deprecated runtime
namedescriptionrequireddefault
tokenYour github tokenno
projectTokenYour chromatic project tokenyes
workingDirWorking directory for the package.json fileno
appCodeDeprecated, please use projectToken insteadno
buildScriptNameThe npm script that builds your Storybook [build-storybook]no
scriptNameThe npm script that starts your Storybook [storybook]no
execAlternatively, a full command to run to start your storybookno
skipSkip Chromatic tests, but mark the commit as passingno
dryRunRun without actually publishing to Chromaticno
forceRebuildDo not skip build when a rebuild is detectedno
storybookBaseDirRelative path from repository root to Storybook project rootno
storybookConfigDirRelative path from where you run Chromatic to your Storybook config directoryno
onlyDeprecated, replaced by onlyStoryNamesno
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
externalsDisable TurboSnap when any of these files have changed since the baseline buildno
untracedDisregard these files and their dependencies when tracing dependent stories for TurboSnapno
traceChangedPrint dependency trace for changed files to affected story files; set to "expanded" to list individual modulesno
doNotStartDo not attempt to start or build; use if your Storybook is already runningno
diagnosticsWrite process context information to chromatic-diagnostics.jsonno
debugOutput verbose debugging information.no
storybookBuildDirProvide a directory with your built storybook; use if you have already built your storybookno
storybookCaUse if Storybook is running on https (auto detected from -s, if set)no
storybookCertUse if Storybook is running on https (auto detected from -s, if set)no
storybookHttpsUse if Storybook is running on https (auto detected from -s, if set)no
storybookKeyUse if Storybook is running on https (auto detected from -s, if set)no
storybookPortWhat port is your Storybook running on (auto detected from -s, if set)no
storybookUrlStorybook is already running at (external) url (implies -S)no
preserveMissingDeprecated, use onlyChanged, onlyStoryNames or onlyStoryFiles insteadno
autoAcceptChangesAutomatically accept all changes in chromatic: boolean or branchnameno
allowConsoleErrorsDo not exit when runtime errors occur in storybookno
exitZeroOnChangesPositive exit of action even when there are changes: boolean or branchnameno
exitOnceUploadedExit with 0 once the built version has been sent to chromatic: boolean or branchnameno
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
zipPublish your Storybook to Chromatic as a single zip file instead of individual content filesno
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)