You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-18Lines changed: 9 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,15 +121,6 @@ Runs the jest test suite
121
121
### `yarn lint`
122
122
123
123
Runs ESLint to report on any style violations
124
-
### Visual testing
125
-
126
-
1. Join BrowserStack (ask Brian for link)
127
-
1. Navigate to this project in percy [here](https://percy.io/f38ae9b9/ui-design-system)
128
-
1. Define `PERCY_TOKEN` in shell (the one from ui-design-system project)
129
-
1.`npx percy exec -- cypress run`
130
-
1. View results in percy.io / console
131
-
132
-
> Note- we are on the free plan (5k images/month) so be mindful of the limit
133
124
134
125
### `yarn rs:link`
135
126
@@ -142,18 +133,18 @@ Trigger a production build when files are changed.
142
133
### `yarn rs:unlink`
143
134
144
135
Remove symlinked packages.
145
-
### Visual testing
146
136
147
-
1. Join BrowserStack team (ask Brian/Bob for link)
148
-
1. Navigate to this project in [Percy](https://percy.io/f38ae9b9/ui-design-system)
137
+
## Chromatic visual testing & live feedback
138
+
We use [Chromatic](https://www.chromatic.com/) for visual testing and gathering UI feedback.
139
+
140
+
To join Chromatic for 'ui-design-system', ask Jason for the join link.
149
141
150
-
## Local setup
151
-
1. Define `PERCY_TOKEN` ENV (the one from ui-design-system project found above)
152
-
1. Run `yarn storybook` in one tab
153
-
1. Run `npx percy exec -- cypress run` in another
154
-
1. View results in percy.io & console
142
+
If you are a Product Designer or wanting to view changes on a particular feature branch, a developer can provide a link to that specific Chromatic build.
155
143
156
-
> Note- we are running this once a day via github actions.
144
+
If you are a Developer and want to trigger a Chromatic build,
145
+
1. Join Chromatic for the 'ui-design-system' (ask Jason for the join link).
146
+
2. Go to the Manage tab for 'ui-design-system' > Configure > Find the project token.
147
+
3. In your terminal, run `npx chromatic --project-token <projectToken>`. Use this command when you want to create a build and share with a stakeholder to gather UI feedback. You will be able to find the build on the Chromatic builds dashboard. We currently run automatic nightly builds for Chromatic via Github Actions.
0 commit comments