documentation.yml

name: Documentation

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

jobs:
  build:

    runs-on: ubuntu-latest

    permissions:
      contents: read

    strategy:
      matrix:
        php-versions: ['8.3']

    steps:
      - uses: actions/checkout@v4

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.3
          ini-values:  zend.assertions=1,  assert.exception=1

      - name: Validate composer.json and composer.lock
        run: composer validate --no-check-publish
        working-directory: ./tools/apigen

      - name: Cache Composer packages
        id: composer-apigen-cache
        uses: actions/cache@v4
        with:
          path: tools/apigen/vendor
          key: ${{ runner.os }}-${{ hashFiles('tools/apigen/composer.lock') }}
          restore-keys: |
            ${{ runner.os }}

      - name: Install dependencies
        run: composer install --prefer-dist --no-progress
        working-directory: ./tools/apigen

      - name: Configure autoloader
        run: composer dumpautoload --no-dev

      - name: Generate documentation
        run: ./tools/apigen/apigen

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: 'docs'

  deploy:
    if: ${{ github.event_name != 'pull_request' || !github.event.pull_request.head.repo.fork }}

    needs: build

    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest

    concurrency:
      group: "pages"
      cancel-in-progress: true

    steps:
      - name: Dump GitHub context
        env:
          GITHUB_CONTEXT: ${{ toJSON(github) }}
        run: echo "$GITHUB_CONTEXT"; env

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@main