addaxlabs/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 tokenyes
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
doNotStartDo not attempt to start or build; use if your Storybook is already runningno
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
preserveMissingPass the baselines forward and treat all missing stories as “preserved” without re-capturing themno
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
namedescription
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/)
codeThe exit code for the current run of the Chromatic CLI