deployphp/deployer

View on GitHub
.github/workflows/docs.yml

Summary

Maintainability
Test Coverage
name: doc

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  docgen:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Validate composer.json and composer.lock
        run: composer validate

      - name: Get Composer Cache Directory
        id: composer-cache
        run: |
          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT

      - uses: actions/cache@v4
        with:
          path: ${{ steps.composer-cache.outputs.dir }}
          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
          restore-keys: |
            ${{ runner.os }}-composer-

      - name: Install dependencies
        if: steps.composer-cache.outputs.cache-hit != 'true'
        run: composer install --prefer-dist --no-progress

      - name: Run docgen
        run: php bin/docgen

      - name: Check for uncommitted changes
        run: |
          status=$(git status --porcelain docs/);
          [ -z "$status" ] || {
            echo "Please, run bin/docgen and commit next files:";
            echo $status;
            exit 1;
          }