# Introduction Running `storybook` with `configuration=pages` outputs a coverage that is not replicated afterwards by the `storybook:coverage` command. ```sh npx nx storybook:serve-and-test:static twenty-front --configuration=pages --shard=1/1 --checkCoverage=true # ... [TEST] Test Suites: 40 passed, 40 total [TEST] Tests: 52 passed, 52 total [TEST] Snapshots: 0 total [TEST] Time: 84.786 s [TEST] Ran all test suites. [TEST] Coverage file (13067196 bytes) written to .nyc_output/coverage.json [TEST] > nx storybook:coverage twenty-front --coverageDir=coverage/storybook --checkCoverage=true [TEST] [TEST] [TEST] > nx run twenty-front:"storybook:coverage" --coverageDir=coverage/storybook --checkCoverage=true [TEST] [TEST] > npx nyc report --reporter=lcov --reporter=text-summary -t coverage/storybook --report-dir coverage/storybook --check-coverage=true --cwd=packages/twenty-front [TEST] [TEST] [TEST] =============================== Coverage summary =============================== [TEST] Statements : 70.45% ( 775/1100 ) [TEST] Branches : 45.39% ( 197/434 ) [TEST] Functions : 63.52% ( 209/329 ) [TEST] Lines : 71.28% ( 767/1076 ) [TEST] ================================================================================ [TEST] ``` ```sh > npx nyc report --reporter=lcov --reporter=text-summary -t coverage/storybook --report-dir coverage/storybook --check-coverage=true --cwd=packages/twenty-front =============================== Coverage summary =============================== Statements : 37.4% ( 9326/24931 ) Branches : 22.99% ( 2314/10063 ) Functions : 28.27% ( 2189/7741 ) Lines : 37.81% ( 9261/24488 ) ================================================================================ ERROR: Coverage for lines (37.81%) does not meet global threshold (39%) ERROR: Coverage for branches (22.99%) does not meet global threshold (23%) ERROR: Coverage for statements (37.4%) does not meet global threshold (39%) Warning: command "npx nyc report --reporter=lcov --reporter=text-summary -t coverage/storybook --report-dir coverage/storybook --check-coverage=true --cwd=packages/twenty-front" exited with non-zero status code ``` ## Fix Persist configuration scope arg to the `check-coverage` command ## Question Should we add a step in the `ci-front` what would merge all `performance,modules,pages` coverage and calculate the `global` coverage ? => I think that this has no plus value as we still compute each of them individualy
207 lines
7.1 KiB
YAML
207 lines
7.1 KiB
YAML
name: CI Front
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
pull_request:
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
STORYBOOK_BUILD_CACHE_KEY: storybook-build-depot-ubuntu-24.04-8-runner
|
|
|
|
jobs:
|
|
changed-files-check:
|
|
uses: ./.github/workflows/changed-files.yaml
|
|
with:
|
|
files: |
|
|
package.json
|
|
packages/twenty-front/**
|
|
packages/twenty-ui/**
|
|
packages/twenty-shared/**
|
|
front-sb-build:
|
|
needs: [changed-files-check]
|
|
if: needs.changed-files-check.outputs.any_changed == 'true'
|
|
timeout-minutes: 30
|
|
runs-on: depot-ubuntu-24.04-8
|
|
env:
|
|
REACT_APP_SERVER_BASE_URL: http://localhost:3000
|
|
NX_REJECT_UNKNOWN_LOCAL_CACHE: 0
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.11.0
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
- name: Fetch local actions
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Install dependencies
|
|
uses: ./.github/workflows/actions/yarn-install
|
|
- name: Diagnostic disk space issue
|
|
run: df -h
|
|
- name: Restore storybook build cache
|
|
id: restore-storybook-build-cache
|
|
uses: ./.github/workflows/actions/restore-cache
|
|
with:
|
|
key: ${{ env.STORYBOOK_BUILD_CACHE_KEY }}
|
|
- name: Front / Write .env
|
|
run: npx nx reset:env twenty-front
|
|
- name: Front / Build storybook
|
|
run: npx nx storybook:build twenty-front
|
|
- name: Save storybook build cache
|
|
uses: ./.github/workflows/actions/save-cache
|
|
with:
|
|
key: ${{ steps.restore-storybook-build-cache.outputs.cache-primary-key }}
|
|
front-sb-test:
|
|
timeout-minutes: 30
|
|
runs-on: depot-ubuntu-24.04-8
|
|
needs: front-sb-build
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
shard: [1, 2, 3, 4]
|
|
storybook_scope: [modules, pages, performance]
|
|
env:
|
|
SHARD_COUNTER: 4
|
|
REACT_APP_SERVER_BASE_URL: http://localhost:3000
|
|
NX_REJECT_UNKNOWN_LOCAL_CACHE: 0
|
|
steps:
|
|
- name: Fetch local actions
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Install dependencies
|
|
uses: ./.github/workflows/actions/yarn-install
|
|
- name: Install Playwright
|
|
run: cd packages/twenty-front && npx playwright install
|
|
- name: Restore storybook build cache
|
|
uses: ./.github/workflows/actions/restore-cache
|
|
with:
|
|
key: ${{ env.STORYBOOK_BUILD_CACHE_KEY }}
|
|
- name: Front / Write .env
|
|
run: npx nx reset:env twenty-front
|
|
- name: Run storybook tests
|
|
run: npx nx storybook:serve-and-test:static twenty-front --configuration=${{ matrix.storybook_scope }} --shard=${{ matrix.shard }}/${{ env.SHARD_COUNTER }} --checkCoverage=false
|
|
- name: Rename coverage file
|
|
run: mv packages/twenty-front/coverage/storybook/coverage-storybook.json packages/twenty-front/coverage/storybook/coverage-shard-${{matrix.shard}}.json
|
|
- name: Upload coverage artifact
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
retention-days: 1
|
|
name: coverage-artifacts-${{ matrix.storybook_scope }}-${{ github.run_id }}-${{ matrix.shard }}
|
|
path: packages/twenty-front/coverage/storybook/coverage-shard-${{matrix.shard}}.json
|
|
merge-reports-and-check-coverage:
|
|
timeout-minutes: 30
|
|
runs-on: depot-ubuntu-24.04-8
|
|
needs: front-sb-test
|
|
env:
|
|
PATH_TO_COVERAGE: packages/twenty-front/coverage/storybook
|
|
strategy:
|
|
matrix:
|
|
storybook_scope: [modules, pages, performance]
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Install dependencies
|
|
uses: ./.github/workflows/actions/yarn-install
|
|
- uses: actions/download-artifact@v4
|
|
with:
|
|
pattern: coverage-artifacts-${{ matrix.storybook_scope }}-${{ github.run_id }}-*
|
|
merge-multiple: true
|
|
path: coverage-artifacts
|
|
- name: Merge coverage reports
|
|
run: |
|
|
mkdir -p ${{ env.PATH_TO_COVERAGE }}
|
|
npx nyc merge coverage-artifacts ${{ env.PATH_TO_COVERAGE }}/coverage-storybook.json
|
|
- name: Checking coverage
|
|
run: npx nx storybook:coverage twenty-front --checkCoverage=true --configuration=${{ matrix.storybook_scope }}
|
|
front-chromatic-deployment:
|
|
timeout-minutes: 30
|
|
if: contains(github.event.pull_request.labels.*.name, 'run-chromatic') || github.event_name == 'push'
|
|
needs: front-sb-build
|
|
runs-on: depot-ubuntu-24.04-8
|
|
env:
|
|
REACT_APP_SERVER_BASE_URL: http://127.0.0.1:3000
|
|
CHROMATIC_PROJECT_TOKEN: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
|
|
NX_REJECT_UNKNOWN_LOCAL_CACHE: 0
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Install dependencies
|
|
uses: ./.github/workflows/actions/yarn-install
|
|
- name: Restore storybook build cache
|
|
uses: ./.github/workflows/actions/restore-cache
|
|
with:
|
|
key: ${{ env.STORYBOOK_BUILD_CACHE_KEY }}
|
|
- name: Front / Write .env
|
|
run: |
|
|
cd packages/twenty-front
|
|
touch .env
|
|
echo "REACT_APP_SERVER_BASE_URL: $REACT_APP_SERVER_BASE_URL" >> .env
|
|
- name: Publish to Chromatic
|
|
run: npx nx run twenty-front:chromatic:ci
|
|
front-task:
|
|
needs: changed-files-check
|
|
if: needs.changed-files-check.outputs.any_changed == 'true'
|
|
timeout-minutes: 30
|
|
runs-on: depot-ubuntu-24.04-8
|
|
env:
|
|
NX_REJECT_UNKNOWN_LOCAL_CACHE: 0
|
|
TASK_CACHE_KEY: front-task-${{ matrix.task }}
|
|
strategy:
|
|
matrix:
|
|
task: [lint, typecheck, test]
|
|
steps:
|
|
- name: Cancel Previous Runs
|
|
uses: styfle/cancel-workflow-action@0.11.0
|
|
with:
|
|
access_token: ${{ github.token }}
|
|
- name: Fetch custom Github Actions and base branch history
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Install dependencies
|
|
uses: ./.github/workflows/actions/yarn-install
|
|
- name: Restore ${{ matrix.task }} cache
|
|
id: restore-task-cache
|
|
uses: ./.github/workflows/actions/restore-cache
|
|
with:
|
|
key: ${{ env.TASK_CACHE_KEY }}
|
|
- name: Reset .env
|
|
uses: ./.github/workflows/actions/nx-affected
|
|
with:
|
|
tag: scope:frontend
|
|
tasks: reset:env
|
|
- name: Run ${{ matrix.task }} task
|
|
uses: ./.github/workflows/actions/nx-affected
|
|
with:
|
|
tag: scope:frontend
|
|
tasks: ${{ matrix.task }}
|
|
- name: Save ${{ matrix.task }} cache
|
|
uses: ./.github/workflows/actions/save-cache
|
|
with:
|
|
key: ${{ steps.restore-task-cache.outputs.cache-primary-key }}
|
|
ci-front-status-check:
|
|
if: always() && !cancelled()
|
|
timeout-minutes: 1
|
|
runs-on: depot-ubuntu-24.04-8
|
|
needs:
|
|
[
|
|
changed-files-check,
|
|
front-task,
|
|
front-chromatic-deployment,
|
|
merge-reports-and-check-coverage,
|
|
front-sb-test,
|
|
front-sb-build,
|
|
]
|
|
steps:
|
|
- name: Fail job if any needs failed
|
|
if: contains(needs.*.result, 'failure')
|
|
run: exit 1
|