From 5db38df3278392436fdd9c74ad1f548fe10bd1be Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Wed, 22 Nov 2023 09:21:43 +0100 Subject: [PATCH] provide readme & fetch-depth for git history --- .github/workflows/frontend.deploy.chromatic.yml | 2 ++ README.md | 14 ++++++++++++++ 2 files changed, 16 insertions(+) diff --git a/.github/workflows/frontend.deploy.chromatic.yml b/.github/workflows/frontend.deploy.chromatic.yml index daa1fb0..f808821 100644 --- a/.github/workflows/frontend.deploy.chromatic.yml +++ b/.github/workflows/frontend.deploy.chromatic.yml @@ -13,6 +13,8 @@ jobs: steps: - name: Checkout code uses: actions/checkout@v3 + with: + fetch-depth: 0 - name: Frontend | Build run: npm install && npm run chromatic -- --exit-zero-on-changes \ No newline at end of file diff --git a/README.md b/README.md index fa12e5e..cc1cae6 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,20 @@ Docker can be run in production mode: docker compose -f docker-compose.yml up ``` +### Chromatic + +In order to use the chromatic workflow you need to provide a `CHROMATIC_PROJECT_TOKEN` in the repository secrets. + +If you want to run chromatic from the command line you either have to provide this variable as well +``` +export CHROMATIC_PROJECT_TOKEN=... +npm run chromatic +``` +or you have to append it via parameter: +``` +npm run chromatic -- --project-token=... +``` + ## Endpoints The following endpoints are provided given the right command is executed or all three if `docker compose` is used: