docs.yml

name: Docs sync

on:
  workflow_dispatch:
  push:
    paths:
      - 'composer.json'
      - '.github/workflows/test.yml'
      - '.github/workflows/docs.yml'
      - 'src/Console/Commands/**'
      - 'src/Domain/Blueprint/Contracts/**'
      - 'bin/docs-sync.php'
      - 'website/src/generated/**'
      - 'README.md'
  pull_request:

jobs:
  docs-sync:
    runs-on: ubuntu-latest
    name: Verify generated docs are in sync
    steps:
      - name: Checkout code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Setup PHP
        uses: shivammathur/setup-php@f3e473d116dcccaddc5834248c87452386958240 # v2.37.2
        with:
          php-version: '8.4'
          extensions: dom, curl, libxml, mbstring, zip
          coverage: none

      - name: Install dependencies
        run: composer update --no-ansi --no-interaction --no-progress --prefer-dist

      - name: Check documentation is in sync with source
        run: composer docs:check