Update best-practices-front.mdx (#8836) #5
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
| name: CI Front | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| front-sb-build: | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-latest | |
| env: | |
| REACT_APP_SERVER_BASE_URL: http://localhost:3000 | |
| NX_REJECT_UNKNOWN_LOCAL_CACHE: 0 | |
| steps: | |
| - name: Cancel Previous Runs | |
| uses: styfle/[email protected] | |
| with: | |
| access_token: ${{ github.token }} | |
| - name: Fetch local actions | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Check for changed files | |
| id: changed-files | |
| uses: tj-actions/changed-files@v11 | |
| with: | |
| files: | | |
| package.json | |
| packages/twenty-front/** | |
| packages/twenty-ui/** | |
| - name: Skip if no relevant changes | |
| if: steps.changed-files.outputs.any_changed == 'false' | |
| run: echo "No relevant changes. Skipping CI." | |
| - name: Install dependencies | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/yarn-install | |
| - name: Diagnostic disk space issue | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: df -h | |
| - name: Front / Restore Storybook Task Cache | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/task-cache | |
| with: | |
| tag: scope:frontend | |
| tasks: storybook:build | |
| - name: Front / Write .env | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: npx nx reset:env twenty-front | |
| - name: Front / Build storybook | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: npx nx storybook:build twenty-front | |
| front-sb-test: | |
| timeout-minutes: 30 | |
| runs-on: shipfox-8vcpu-ubuntu-2204 | |
| needs: front-sb-build | |
| strategy: | |
| matrix: | |
| storybook_scope: [pages, modules] | |
| env: | |
| 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: Check for changed files | |
| id: changed-files | |
| uses: tj-actions/changed-files@v11 | |
| with: | |
| files: | | |
| packages/twenty-front/** | |
| - name: Skip if no relevant changes | |
| if: steps.changed-files.outputs.any_changed == 'false' | |
| run: echo "No relevant changes. Skipping CI." | |
| - name: Install dependencies | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/yarn-install | |
| - name: Install Playwright | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: cd packages/twenty-front && npx playwright install | |
| - name: Front / Restore Storybook Task Cache | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/task-cache | |
| with: | |
| tag: scope:frontend | |
| tasks: storybook:build | |
| - name: Front / Write .env | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: npx nx reset:env twenty-front | |
| - name: Run storybook tests | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: npx nx storybook:serve-and-test:static twenty-front --configuration=${{ matrix.storybook_scope }} | |
| front-sb-test-performance: | |
| timeout-minutes: 30 | |
| runs-on: shipfox-8vcpu-ubuntu-2204 | |
| env: | |
| 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: Check for changed files | |
| id: changed-files | |
| uses: tj-actions/changed-files@v11 | |
| with: | |
| files: | | |
| packages/twenty-front/** | |
| - name: Skip if no relevant changes | |
| if: steps.changed-files.outputs.any_changed == 'false' | |
| run: echo "No relevant changes. Skipping CI." | |
| - name: Install dependencies | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/yarn-install | |
| - name: Install Playwright | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: cd packages/twenty-front && npx playwright install | |
| - name: Front / Write .env | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: npx nx reset:env twenty-front | |
| - name: Run storybook tests | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: npx nx run twenty-front:storybook:serve-and-test:static:performance | |
| 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: ubuntu-latest | |
| 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: Check for changed files | |
| id: changed-files | |
| uses: tj-actions/changed-files@v11 | |
| with: | |
| files: | | |
| packages/twenty-front/** | |
| - name: Skip if no relevant changes | |
| if: steps.changed-files.outputs.any_changed == 'false' | |
| run: echo "No relevant changes. Skipping CI." | |
| - name: Install dependencies | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/yarn-install | |
| - name: Front / Restore Storybook Task Cache | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/task-cache | |
| with: | |
| tag: scope:frontend | |
| tasks: storybook:build | |
| - name: Front / Write .env | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: | | |
| cd packages/twenty-front | |
| touch .env | |
| echo "REACT_APP_SERVER_BASE_URL: $REACT_APP_SERVER_BASE_URL" >> .env | |
| - name: Publish to Chromatic | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| run: npx nx run twenty-front:chromatic:ci | |
| front-task: | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-latest | |
| env: | |
| NX_REJECT_UNKNOWN_LOCAL_CACHE: 0 | |
| strategy: | |
| matrix: | |
| task: [lint, typecheck, test] | |
| steps: | |
| - name: Cancel Previous Runs | |
| uses: styfle/[email protected] | |
| with: | |
| access_token: ${{ github.token }} | |
| - name: Fetch custom Github Actions and base branch history | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Check for changed files | |
| id: changed-files | |
| uses: tj-actions/changed-files@v11 | |
| with: | |
| files: | | |
| packages/twenty-front/** | |
| - name: Skip if no relevant changes | |
| if: steps.changed-files.outputs.any_changed == 'false' | |
| run: echo "No relevant changes. Skipping CI." | |
| - name: Install dependencies | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/yarn-install | |
| - name: Front / Restore ${{ matrix.task }} task cache | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/task-cache | |
| with: | |
| tag: scope:frontend | |
| tasks: ${{ matrix.task }} | |
| - name: Reset .env | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/nx-affected | |
| with: | |
| tag: scope:frontend | |
| tasks: reset:env | |
| - name: Run ${{ matrix.task }} task | |
| if: steps.changed-files.outputs.any_changed == 'true' | |
| uses: ./.github/workflows/actions/nx-affected | |
| with: | |
| tag: scope:frontend | |
| tasks: ${{ matrix.task }} |