twenty/.github/workflows/ci-docs.yaml

name: CI Docs

on:
  push:
    branches:
      - main

  pull_request:

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

jobs:
  changed-files-check:
    uses: ./.github/workflows/changed-files.yaml
    with:
      files: |
        package.json
        yarn.lock
        packages/twenty-ui/**
        packages/twenty-shared/**
        .github/workflows/ci-docs.yaml
        packages/twenty-docs/**

  docs-lint:
    needs: changed-files-check
    if: needs.changed-files-check.outputs.any_changed == 'true'
    timeout-minutes: 10
    runs-on: ubuntu-latest
    steps:
      - name: Fetch local actions
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
        with:
          fetch-depth: 10

      - name: Install dependencies
        uses: ./.github/actions/yarn-install

      - name: Docs / Lint
        run: npx nx lint twenty-docs

      - name: Docs / Test
        run: npx nx test twenty-docs

      - name: Docs / Generated UI references
        run: npx nx check:ui twenty-docs

      - name: Docs / Storybook embeds
        run: npx nx check:ui-stories twenty-docs