-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Added an available options docs page
- Loading branch information
1 parent
9064656
commit 32a279e
Showing
2 changed files
with
57 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
icon: gear | ||
--- | ||
|
||
# Available options | ||
|
||
Most of Chromatic [CLI options](https://www.chromatic.com/docs/cli/#configuration-options) are accepted by the `@workleap/chromatic-ado` script. If an option is not accepted, the script will output an error message. | ||
|
||
In addition to Chromatic CLI options, a few environment variables are accepted. | ||
|
||
## CHROMATIC_DEBUG | ||
|
||
Add the `CHROMATIC_DEBUG` environment variable to your `chromatic.yml` pipeline to start a Chromatic build in "debug" mode and to benefit from additional logs from the `@workleap/chromatic-ado` script: | ||
|
||
```yaml !#8 chromatic.yml | ||
- task: CmdLine@2 | ||
displayName: Chromatic | ||
inputs: | ||
script: pnpm dlx @workleap/chromatic-ado | ||
env: | ||
CHROMATIC_PROJECT_TOKEN: $(CHROMATIC_PROJECT_TOKEN) | ||
CHROMATIC_PULL_REQUEST_COMMENT_ACCESS_TOKEN: $(PULL_REQUEST_COMMENT_ACCESS_TOKEN) | ||
CHROMATIC_DEBUG: true | ||
``` | ||
## CHROMATIC_DISABLE_TURBOSNAP | ||
Add the `CHROMATIC_DISABLE_TURBOSNAP` environment variable to your `chromatic.yml` pipeline to start a Chromatic build without [TurboSnap](https://www.chromatic.com/docs/turbosnap/): | ||
|
||
```yaml !#8 chromatic.yml | ||
- task: CmdLine@2 | ||
displayName: Chromatic | ||
inputs: | ||
script: pnpm dlx @workleap/chromatic-ado | ||
env: | ||
CHROMATIC_PROJECT_TOKEN: $(CHROMATIC_PROJECT_TOKEN) | ||
CHROMATIC_PULL_REQUEST_COMMENT_ACCESS_TOKEN: $(PULL_REQUEST_COMMENT_ACCESS_TOKEN) | ||
CHROMATIC_DISABLE_TURBOSNAP: true | ||
``` | ||
|
||
!!!info | ||
Note that we strongly encourage using TurboSnap as Chromatic snapshots are not cheap. | ||
!!! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters