Skip to content

Commit

Permalink
Merge pull request #330 from chromaui/configuration-file-and-action-docs
Browse files Browse the repository at this point in the history
Document the 'chromatic.config.json' configuration file and update GitHub Action docs
  • Loading branch information
ghengeveld authored Dec 2, 2023
2 parents 673e695 + 5b99904 commit dc71110
Show file tree
Hide file tree
Showing 15 changed files with 254 additions and 366 deletions.
8 changes: 4 additions & 4 deletions src/content/ci/azure-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ stages:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -351,7 +351,7 @@ stages:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -386,7 +386,7 @@ stages:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand All @@ -412,7 +412,7 @@ chromatic --skip 'renovate/**'

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down
8 changes: 4 additions & 4 deletions src/content/ci/bitbucket-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ pipelines:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -260,7 +260,7 @@ pipelines:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -288,7 +288,7 @@ pipelines:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -349,7 +349,7 @@ chromatic --skip 'renovate/**'

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down
6 changes: 3 additions & 3 deletions src/content/ci/circleci.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ jobs:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -255,7 +255,7 @@ fi

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -304,7 +304,7 @@ chromatic --skip 'dependabot/**'

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down
6 changes: 3 additions & 3 deletions src/content/ci/custom-ci-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ If you are using pull request statuses as required checks before merging, you ma

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -181,7 +181,7 @@ If you’re using this functionality but notice the incoming changes were not ac

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand All @@ -207,7 +207,7 @@ chromatic --skip 'dependabot/**'

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down
387 changes: 121 additions & 266 deletions src/content/ci/github-actions.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions src/content/ci/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ chromatic_publish:

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -283,7 +283,7 @@ chromatic_publish:

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand All @@ -310,7 +310,7 @@ chromatic_publish:

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand All @@ -336,7 +336,7 @@ chromatic --skip 'renovate/**'

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down
8 changes: 4 additions & 4 deletions src/content/ci/jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ pipeline {

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -362,7 +362,7 @@ pipeline {

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -395,7 +395,7 @@ pipeline {

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand All @@ -421,7 +421,7 @@ chromatic --skip 'dependabot/**'

<div class="aside">

Read our official [CLI documentation](/docs/cli#chromatic-options).
Read our official [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down
8 changes: 4 additions & 4 deletions src/content/ci/travisci.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ jobs:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down Expand Up @@ -244,7 +244,7 @@ jobs:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand All @@ -269,7 +269,7 @@ jobs:

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand All @@ -295,7 +295,7 @@ chromatic --skip 'dependabot/**'

<div class="aside">

Read our [CLI documentation](/docs/cli#chromatic-options).
Read our [CLI documentation](/docs/cli#configuration-options).

</div>

Expand Down
Loading

1 comment on commit dc71110

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.