forked from chromaui/chromatic-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
action.yml
executable file
·154 lines (151 loc) · 5.94 KB
/
action.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
name: Publish to Chromatic
author: Chroma Software, Inc.
description: 'Publish your Storybook to Chromatic and run visual regression tests'
branding:
icon: 'aperture'
color: 'orange'
inputs:
allowConsoleErrors:
description: 'Do not exit when runtime errors occur in storybook'
required: false
appCode:
description: 'Deprecated, please use projectToken instead'
required: false
autoAcceptChanges:
description: 'Automatically accept all changes in chromatic: boolean or branchname'
required: false
branchName:
description: 'Override the branch name'
required: false
buildScriptName:
description: 'The npm script that builds your Storybook [build-storybook]'
required: false
configFile:
description: 'Path from where to load the Chromatic config JSON file.'
cypress:
description: 'Run build against `@chromatic-com/cypress` test archives'
required: false
debug:
description: 'Output verbose debugging information'
required: false
diagnostics:
description: 'Deprecated, use diagnosticsFile instead'
required: false
diagnosticsFile:
description: 'Write process context information to a JSON file'
required: false
dryRun:
description: 'Run without actually publishing to Chromatic'
required: false
exitOnceUploaded:
description: 'Exit with 0 once the built version has been sent to chromatic: boolean or branchname'
required: false
exitZeroOnChanges:
description: 'Positive exit of action even when there are changes: boolean or branchname'
required: false
externals:
description: 'Disable TurboSnap when any of these files have changed since the baseline build'
required: false
fileHashing:
description: 'Whether to apply file hashing to skip uploading unchanged files (default: true)'
required: false
forceRebuild:
description: 'Do not skip build when a rebuild is detected'
required: false
ignoreLastBuildOnBranch:
description: 'Do not use the last build on this branch as a baseline if it is no longer in history (i.e. branch was rebased)'
required: false
logFile:
description: 'Write CLI logs to a file'
required: false
only:
description: 'Deprecated, replaced by onlyStoryNames'
required: false
onlyChanged:
description: 'Enables TurboSnap: Only run stories affected by files changed since the baseline build'
required: false
onlyStoryNames:
description: 'Only run a single story or a subset of stories by their name'
required: false
onlyStoryFiles:
description: 'Only run a single story or a subset of stories by their filename(s)'
required: false
playwright:
description: 'Run build against `@chromatic-com/playwright` test archives'
required: false
preserveMissing:
description: 'Deprecated, use onlyChanged, onlyStoryNames or onlyStoryFiles instead'
required: false
projectToken:
description: 'Your chromatic project token (best provided via env.CHROMATIC_PROJECT_TOKEN)'
required: false
repositorySlug:
description: 'Override the repository slug (e.g. ownerName/repositoryName)'
required: false
skip:
description: 'Skip Chromatic tests, but mark the commit as passing'
required: false
skipUpdateCheck:
description: 'Skips Chromatic CLI update check'
required: false
storybookBaseDir:
description: 'Relative path from repository root to Storybook project root'
required: false
storybookBuildDir:
description: 'Provide a directory with your built storybook; use if you have already built your storybook'
required: false
storybookConfigDir:
description: 'Relative path from where you run Chromatic to your Storybook config directory'
required: false
storybookLogFile:
description: 'Write Storybook build logs to a file'
required: false
token:
description: 'Your github token'
required: false
traceChanged:
description: 'Print dependency trace for changed files to affected story files; set to "expanded" to list individual modules'
required: false
untraced:
description: 'Disregard these files and their dependencies when tracing dependent stories for TurboSnap'
required: false
uploadMetadata:
description: 'Upload Chromatic metadata files as part of the published Storybook'
required: false
workingDir:
description: 'Working directory for the package.json file'
required: false
zip:
description: 'Publish your Storybook to Chromatic as a single zip file instead of individual content files'
required: false
junitReport:
description: 'Write build results to a JUnit XML file'
required: false
outputs:
code:
description: 'The exit code for the current run of the Chromatic CLI'
url:
description: 'An alias for the build URL (e.g. https://www.chromatic.com/build?appId=<app id goes here>&number=<build number>)'
buildUrl:
description: 'The build URL (e.g. https://www.chromatic.com/build?appId=<app id goes here>&number=<build number>)'
storybookUrl:
description: 'The Storybook preview URL for your current branch / Pull Request (e.g. https://<app id goes here>-<branch hash>.chromatic.com/)'
specCount:
description: 'The number of stories in the published Storybook'
componentCount:
description: 'The number of components in the published Storybook'
testCount:
description: 'The number of tests on the build'
changeCount:
description: 'The number of tests with visual changes, including any inherited changes (e.g. due to TurboSnap)'
errorCount:
description: 'The number of tests with error(s), including any inherited errors (e.g. due to TurboSnap)'
interactionTestFailuresCount:
description: 'The number of stories with interaction test failures'
actualCaptureCount:
description: 'The number of captured snapshots'
inheritedCaptureCount:
description: 'The number of inherited (not captured) snapshots (e.g. due to TurboSnap)'
runs:
main: action/register.js
using: node20 # Sync with `target` in tsup.config.ts