@narmi/design_system 6.8.2 → 6.8.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -24
- package/dist/index.js +66 -11
- package/dist/index.js.map +1 -1
- package/dist/style.css +1 -1
- package/dist/style.css.map +1 -1
- package/dist/tokens/css/rgbColors.css +1 -1
- package/dist/tokens/css/rgbColors.scss +1 -1
- package/dist/tokens/css/tokens.css +1 -1
- package/dist/tokens/css/tokens.scss +1 -1
- package/dist/tokens/js/colors.esm.js +1 -1
- package/dist/tokens/js/colors.js +1 -1
- package/dist/tokens/js/manifest.esm.js +1 -1
- package/dist/tokens/js/manifest.js +1 -1
- package/dist/tokens/js/reactNativeWeb.js +1 -1
- package/dist/types/Alert/index.d.ts.map +1 -1
- package/dist/types/Checkbox/index.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -163,35 +163,13 @@ If you are making a breaking change, please [note it in your commit message](htt
|
|
|
163
163
|
|
|
164
164
|
The workflow that runs visual snapshot testing is "Chromatic PR Checks"/`run_chromatic`. All pull requests will block merging until this workflow passes.
|
|
165
165
|
|
|
166
|
-
|
|
166
|
+
On every push to a PR, this workflow will run snapshots and report results via a comment on the PR. Use the provided links to review diffs in the Chromatic build and/or view the Storybook preview build.
|
|
167
167
|
|
|
168
|
-
-
|
|
169
|
-
- Visual changes detected, but approved (indicates an intentional change)
|
|
170
|
-
- Visual changes resolved by a code change to match baseline snapshots
|
|
171
|
-
- New stories added in the PR are approved in the Chromatic build
|
|
172
|
-
|
|
173
|
-
Failing conditions for tests:
|
|
174
|
-
|
|
175
|
-
- Chromatic build has unreviewed diffs
|
|
176
|
-
- Chromatic build has denied changes
|
|
177
|
-
- New stories haven't been explicitly approved in the Chromatic build
|
|
178
|
-
|
|
179
|
-
On every push to a PR, this workflow will run snapshots and report results via a
|
|
180
|
-
comment on the PR. Use the provided links to review diffs in the Chromatic build and/or view the Storybook preview build.
|
|
181
|
-
|
|
182
|
-
This workflow must be run again to confirm snapshots are passing, triggered by a new push to the PR or by manually running the job.
|
|
168
|
+
For a detailed step-by-step guide on resolving failing Chromatic checks, see the [Visual Regression Tests](//github.com/narmi/design_system/tree/main/contributing/visual-regression-tests.md) contributing guide.
|
|
183
169
|
|
|
184
170
|
**🔑 Authentication Required:**
|
|
185
171
|
While the Storybook preview is public, you must log into [Chromatic](chromatic.com/start) with Narmi engineering credentials to view details on the build and approve or deny snapshot changes.
|
|
186
172
|
|
|
187
|
-
**Local Snapshots:**
|
|
188
|
-
When running Storybook locally, you'll see a floating button on the bottom left of the viewport labelled "Run Tests". If you're authenticated with chromatic, this will compare your current stories being served on `localhost:6006` against baseline snapshots in Chromatic. Results will appear in the addons panel.
|
|
189
|
-
|
|
190
|
-
**Baselines:**
|
|
191
|
-
Baselines are managed by Chromatic, using the latest _approved_ build, regardless of the PR that triggered it. Once a build is approved, it immediately becomes the new baseline.
|
|
192
|
-
To keep `main` as the branch that should be tracked as the baseline in Chromatic, we run a workflow on
|
|
193
|
-
merges to `main` that creates an auto-accepted build, designating it as the new baseline.
|
|
194
|
-
|
|
195
173
|
### Manual publishing (Narmi only)
|
|
196
174
|
|
|
197
175
|
In rare circumstances, you may need to manually publish a version of NDS outside of the normal automated release process.
|