reports.yml

name: Generate Reports and Deploy to GitHub Pages

on:
    workflow_call:
        inputs:
            cleanup-previews:
                description: Remove stale pull request previews without publishing production reports.
                required: false
                type: boolean
                default: false
    workflow_dispatch:
        inputs:
            cleanup-previews:
                description: Remove stale pull request previews without publishing production reports.
                required: false
                type: boolean
                default: false
    schedule:
        - cron: '41 3 * * *'
    pull_request:
        types: [ "opened", "synchronize", "reopened", "closed" ]
    push:
        branches: [ "main" ]

permissions:
    contents: read

concurrency:
    group: ${{ github.event_name == 'pull_request' && format('reports-preview-pr-{0}', github.event.pull_request.number) || 'reports-pages' }}
    cancel-in-progress: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' }}

env:
    FORCE_COLOR: '1'

jobs:
    resolve_php:
        name: Resolve PHP Version
        runs-on: ubuntu-latest
        outputs:
            php-version: ${{ steps.resolve.outputs.php-version }}
            php-version-source: ${{ steps.resolve.outputs.php-version-source }}

        steps:
            - uses: actions/checkout@v6
            - name: Checkout dev-tools workflow action source
              uses: actions/checkout@v6
              with:
                repository: php-fast-forward/dev-tools
                ref: ${{ github.repository == 'php-fast-forward/dev-tools' && (github.event_name == 'pull_request_target' && github.event.pull_request.base.sha || github.sha) || 'main' }}
                path: .dev-tools-actions
                sparse-checkout: |
                  .github/actions

            - name: Resolve workflow PHP version
              id: resolve
              uses: ./.dev-tools-actions/.github/actions/php/resolve-version

    reports:
        needs: resolve_php
        if: github.event_name != 'schedule' && !(github.event_name == 'workflow_dispatch' && inputs.cleanup-previews) && (github.event_name != 'pull_request' || github.event.action != 'closed')
        name: Generate Reports
        runs-on: ubuntu-latest
        outputs:
            any_generated: ${{ steps.detect_reports.outputs.any_generated }}
            coverage_generated: ${{ steps.detect_reports.outputs.coverage_generated }}
            docs_generated: ${{ steps.detect_reports.outputs.docs_generated }}
            metrics_generated: ${{ steps.detect_reports.outputs.metrics_generated }}
        permissions:
            contents: write

        env:
            REPORTS_TARGET: .dev-tools
            REPORTS_ROOT_VERSION: ${{ github.event_name == 'pull_request' && format('dev-{0}', github.event.pull_request.head.ref) || 'dev-main' }}

        steps:
            - uses: actions/checkout@v6
              with:
                fetch-depth: 0
            - name: Checkout dev-tools workflow action source
              uses: actions/checkout@v6
              with:
                repository: php-fast-forward/dev-tools
                ref: ${{ github.repository == 'php-fast-forward/dev-tools' && (github.event_name == 'pull_request_target' && github.event.pull_request.base.sha || github.sha) || 'main' }}
                path: .dev-tools-actions

            - name: Setup PHP and install dependencies
              uses: ./.dev-tools-actions/.github/actions/php/setup-composer
              with:
                php-version: ${{ needs.resolve_php.outputs.php-version }}
                extensions: pcov, pcntl
                coverage: pcov
                root-version: ${{ env.REPORTS_ROOT_VERSION }}

            - name: Generate reports
              env:
                COMPOSER_ROOT_VERSION: ${{ env.REPORTS_ROOT_VERSION }}
              run: dev-tools reports --target="${REPORTS_TARGET}" --coverage="${REPORTS_TARGET}/coverage" --metrics="${REPORTS_TARGET}/metrics"

            - name: Fix permissions
              run: |
                chmod -c -R +rX "${REPORTS_TARGET}/" | while IFS= read -r line; do
                    echo "::warning title=Invalid file permissions automatically fixed::$line"
                done

            - name: Add .nojekyll
              run: touch "${REPORTS_TARGET}/.nojekyll"

            - name: Remove repository-local caches from published output
              run: rm -rf "${REPORTS_TARGET}/cache"

            - name: Detect generated report surfaces
              id: detect_reports
              run: |
                docs_generated=false
                coverage_generated=false
                metrics_generated=false

                if [ -f "${REPORTS_TARGET}/index.html" ]; then
                  docs_generated=true
                fi

                if [ -f "${REPORTS_TARGET}/coverage/index.html" ]; then
                  coverage_generated=true
                fi

                if [ -f "${REPORTS_TARGET}/metrics/index.html" ]; then
                  metrics_generated=true
                fi

                any_generated=false

                if [ "$docs_generated" = 'true' ] || [ "$coverage_generated" = 'true' ] || [ "$metrics_generated" = 'true' ]; then
                  any_generated=true
                fi

                {
                  echo "docs_generated=$docs_generated"
                  echo "coverage_generated=$coverage_generated"
                  echo "metrics_generated=$metrics_generated"
                  echo "any_generated=$any_generated"
                } >> "$GITHUB_OUTPUT"

            - name: Restore previews from gh-pages
              if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
              uses: actions/checkout@v6
              continue-on-error: true
              with:
                ref: gh-pages
                path: gh-pages-current

            - name: Copy existing previews into publish directory
              if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
              uses: ./.dev-tools-actions/.github/actions/github-pages/restore-previews
              with:
                source: gh-pages-current
                target: ${{ env.REPORTS_TARGET }}

            - name: Deploy main reports
              if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
              uses: peaceiris/actions-gh-pages@v4
              with:
                github_token: ${{ secrets.GITHUB_TOKEN }}
                publish_branch: gh-pages
                publish_dir: ./${{ env.REPORTS_TARGET }}/
                destination_dir: .
                keep_files: false
                force_orphan: false

            - name: Deploy PR preview
              if: github.event_name == 'pull_request'
              uses: peaceiris/actions-gh-pages@v4
              with:
                github_token: ${{ secrets.GITHUB_TOKEN }}
                publish_branch: gh-pages
                publish_dir: ./${{ env.REPORTS_TARGET }}/
                destination_dir: previews/pr-${{ github.event.pull_request.number }}
                keep_files: false
                force_orphan: false

    verify_main_reports:
        if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && !(github.event_name == 'workflow_dispatch' && inputs.cleanup-previews)
        name: Verify Main Reports Deployment
        needs: reports
        runs-on: ubuntu-latest

        steps:
            - uses: actions/checkout@v6
            - name: Checkout dev-tools workflow action source
              uses: actions/checkout@v6
              with:
                repository: php-fast-forward/dev-tools
                ref: ${{ github.repository == 'php-fast-forward/dev-tools' && (github.event_name == 'pull_request_target' && github.event.pull_request.base.sha || github.sha) || 'main' }}
                path: .dev-tools-actions
                sparse-checkout: |
                  .github/actions

            - name: Build deployment checks
              id: build_checks
              env:
                COVERAGE_GENERATED: ${{ needs.reports.outputs.coverage_generated }}
                DOCS_GENERATED: ${{ needs.reports.outputs.docs_generated }}
                METRICS_GENERATED: ${{ needs.reports.outputs.metrics_generated }}
              run: |
                has_checks=false

                {
                  echo 'checks<<EOF'

                  if [ "${DOCS_GENERATED}" = 'true' ]; then
                    echo '/|Reports index'
                    has_checks=true
                  fi

                  if [ "${COVERAGE_GENERATED}" = 'true' ]; then
                    echo '/coverage/|Coverage report'
                    has_checks=true
                  fi

                  if [ "${METRICS_GENERATED}" = 'true' ]; then
                    echo '/metrics/|Metrics report'
                    has_checks=true
                  fi

                  echo 'EOF'
                  echo "has_checks=$has_checks"
                } >> "$GITHUB_OUTPUT"

            - uses: ./.dev-tools-actions/.github/actions/github-pages/verify-deployment
              if: steps.build_checks.outputs.has_checks == 'true'
              with:
                base-url: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
                title: Reports health check failed
                checks: ${{ steps.build_checks.outputs.checks }}

    verify_preview_reports:
        if: github.event_name == 'pull_request' && github.event.action != 'closed'
        name: Verify Pull Request Reports Preview
        needs: reports
        runs-on: ubuntu-latest

        steps:
            - uses: actions/checkout@v6
            - name: Checkout dev-tools workflow action source
              uses: actions/checkout@v6
              with:
                repository: php-fast-forward/dev-tools
                ref: ${{ github.repository == 'php-fast-forward/dev-tools' && (github.event_name == 'pull_request_target' && github.event.pull_request.base.sha || github.sha) || 'main' }}
                path: .dev-tools-actions
                sparse-checkout: |
                  .github/actions

            - name: Build preview deployment checks
              id: build_checks
              env:
                COVERAGE_GENERATED: ${{ needs.reports.outputs.coverage_generated }}
                DOCS_GENERATED: ${{ needs.reports.outputs.docs_generated }}
                METRICS_GENERATED: ${{ needs.reports.outputs.metrics_generated }}
              run: |
                has_checks=false

                {
                  echo 'checks<<EOF'

                  if [ "${DOCS_GENERATED}" = 'true' ]; then
                    echo '/|Preview reports index'
                    has_checks=true
                  fi

                  if [ "${COVERAGE_GENERATED}" = 'true' ]; then
                    echo '/coverage/|Preview coverage report'
                    has_checks=true
                  fi

                  if [ "${METRICS_GENERATED}" = 'true' ]; then
                    echo '/metrics/|Preview metrics report'
                    has_checks=true
                  fi

                  echo 'EOF'
                  echo "has_checks=$has_checks"
                } >> "$GITHUB_OUTPUT"

            - uses: ./.dev-tools-actions/.github/actions/github-pages/verify-deployment
              if: steps.build_checks.outputs.has_checks == 'true'
              with:
                base-url: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}
                title: Preview health check failed
                checks: ${{ steps.build_checks.outputs.checks }}

    comment_preview:
        if: github.event_name == 'pull_request' && github.event.action != 'closed'
        name: Comment Pull Request Preview URLs
        needs:
            - reports
            - verify_preview_reports
        runs-on: ubuntu-latest
        permissions:
            pull-requests: write

        steps:
            - name: Build preview comment
              id: build_comment
              env:
                COVERAGE_GENERATED: ${{ needs.reports.outputs.coverage_generated }}
                DOCS_GENERATED: ${{ needs.reports.outputs.docs_generated }}
                METRICS_GENERATED: ${{ needs.reports.outputs.metrics_generated }}
              run: |
                has_links=false

                {
                  echo 'message<<EOF'
                  echo '🚀 Preview is available for this pull request.'
                  echo

                  if [ "${DOCS_GENERATED}" = 'true' ]; then
                    echo "- Docs: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}/"
                    has_links=true
                  fi

                  if [ "${COVERAGE_GENERATED}" = 'true' ]; then
                    echo "- Coverage: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}/coverage/"
                    has_links=true
                  fi

                  if [ "${METRICS_GENERATED}" = 'true' ]; then
                    echo "- Metrics: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}/metrics/"
                    has_links=true
                  fi

                  echo 'EOF'
                  echo "has_links=$has_links"
                } >> "$GITHUB_OUTPUT"

            - name: Comment preview URLs on pull request
              if: steps.build_comment.outputs.has_links == 'true'
              uses: marocchino/sticky-pull-request-comment@v3
              with:
                header: pr-preview
                message: ${{ steps.build_comment.outputs.message }}

    cleanup_preview:
        if: github.event_name == 'pull_request' && github.event.action == 'closed'
        name: Cleanup Pull Request Preview
        runs-on: ubuntu-latest
        permissions:
            contents: write

        steps:
            - uses: actions/checkout@v6
              with:
                ref: ${{ github.event.repository.default_branch }}
            - name: Checkout dev-tools workflow action source
              uses: actions/checkout@v6
              with:
                repository: php-fast-forward/dev-tools
                ref: ${{ github.repository == 'php-fast-forward/dev-tools' && (github.event_name == 'pull_request_target' && github.event.pull_request.base.sha || github.sha) || 'main' }}
                path: .dev-tools-actions
                sparse-checkout: |
                  .github/actions

            - name: Checkout gh-pages
              uses: actions/checkout@v6
              with:
                ref: gh-pages
                path: gh-pages

            - uses: ./.dev-tools-actions/.github/actions/github-pages/remove-preview
              with:
                path: gh-pages
                pull-request-number: ${{ github.event.pull_request.number }}

            - name: Push changes
              run: |
                cd gh-pages
                git push

    cleanup_orphaned_previews:
        if: github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && inputs.cleanup-previews)
        name: Cleanup Orphaned Pull Request Previews
        runs-on: ubuntu-latest
        permissions:
            contents: write
            pull-requests: read
        outputs:
            deleted: ${{ steps.cleanup.outputs.deleted }}
            skipped: ${{ steps.cleanup.outputs.skipped }}
            unresolved: ${{ steps.cleanup.outputs.unresolved }}

        steps:
            - uses: actions/checkout@v6
            - name: Checkout dev-tools workflow action source
              uses: actions/checkout@v6
              with:
                repository: php-fast-forward/dev-tools
                ref: ${{ github.repository == 'php-fast-forward/dev-tools' && (github.event_name == 'pull_request_target' && github.event.pull_request.base.sha || github.sha) || 'main' }}
                path: .dev-tools-actions
                sparse-checkout: |
                  .github/actions

            - name: Checkout gh-pages
              uses: actions/checkout@v6
              with:
                ref: gh-pages
                path: gh-pages

            - uses: ./.dev-tools-actions/.github/actions/github-pages/cleanup-orphaned-previews
              id: cleanup
              with:
                path: gh-pages

            - name: Push changes
              run: |
                cd gh-pages
                git push

    summarize:
        if: ${{ always() }}
        name: Summarize Reports Workflow
        needs:
            - resolve_php
            - reports
            - verify_main_reports
            - verify_preview_reports
            - cleanup_preview
            - cleanup_orphaned_previews
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v6
            - name: Checkout dev-tools workflow action source
              uses: actions/checkout@v6
              with:
                repository: php-fast-forward/dev-tools
                ref: ${{ github.repository == 'php-fast-forward/dev-tools' && (github.event_name == 'pull_request_target' && github.event.pull_request.base.sha || github.sha) || 'main' }}
                path: .dev-tools-actions
                sparse-checkout: |
                  .github/actions

            - id: build_summary
              env:
                COVERAGE_GENERATED: ${{ needs.reports.outputs.coverage_generated }}
                DOCS_GENERATED: ${{ needs.reports.outputs.docs_generated }}
                METRICS_GENERATED: ${{ needs.reports.outputs.metrics_generated }}
                TRIGGER_LABEL: ${{ github.event_name }}${{ github.event.action && format(':{0}', github.event.action) || '' }}
              run: |
                {
                  echo 'markdown<<EOF'
                  echo '## Reports Workflow Summary'
                  echo
                  echo "- Workflow PHP version: \`${{ needs.resolve_php.outputs.php-version }}\`"
                  echo "- PHP version source: \`${{ needs.resolve_php.outputs.php-version-source }}\`"
                  echo "- Reports job result: \`${{ needs.reports.result }}\`"
                  echo "- Main verification result: \`${{ needs.verify_main_reports.result }}\`"
                  echo "- Preview verification result: \`${{ needs.verify_preview_reports.result }}\`"
                  echo "- Closed-preview cleanup result: \`${{ needs.cleanup_preview.result }}\`"
                  echo "- Orphan cleanup result: \`${{ needs.cleanup_orphaned_previews.result }}\`"
                  echo "- Trigger: \`${TRIGGER_LABEL}\`"

                  if [ "${{ github.event_name }}" = "push" ] || { [ "${{ github.event_name }}" = "workflow_dispatch" ] && [ "${{ inputs.cleanup-previews }}" != "true" ]; }; then
                    if [ "${DOCS_GENERATED}" = 'true' ]; then
                      echo "- Docs: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/"
                    fi
                    if [ "${COVERAGE_GENERATED}" = 'true' ]; then
                      echo "- Coverage: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/coverage/"
                    fi
                    if [ "${METRICS_GENERATED}" = 'true' ]; then
                      echo "- Metrics: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/metrics/"
                    fi
                    echo "- Deployment verification: \`${{ needs.verify_main_reports.result }}\`"
                  fi

                  if [ "${{ github.event_name }}" = "pull_request" ] && [ "${{ github.event.action }}" != "closed" ]; then
                    if [ "${DOCS_GENERATED}" = 'true' ]; then
                      echo "- Preview docs: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}/"
                    fi
                    if [ "${COVERAGE_GENERATED}" = 'true' ]; then
                      echo "- Preview coverage: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}/coverage/"
                    fi
                    if [ "${METRICS_GENERATED}" = 'true' ]; then
                      echo "- Preview metrics: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}/metrics/"
                    fi
                    echo "- Preview verification: \`${{ needs.verify_preview_reports.result }}\`"
                  fi

                  if [ "${{ github.event_name }}" = "pull_request" ] && [ "${{ github.event.action }}" = "closed" ]; then
                    echo "- Deleted preview path: \`previews/pr-${{ github.event.pull_request.number }}\`"
                    echo "- Cleanup result: \`${{ needs.cleanup_preview.result }}\`"
                  fi

                  if [ "${{ github.event_name }}" = "schedule" ] || { [ "${{ github.event_name }}" = "workflow_dispatch" ] && [ "${{ inputs.cleanup-previews }}" = "true" ]; }; then
                    echo "- Cleanup summary: deleted=${{ needs.cleanup_orphaned_previews.outputs.deleted || '0' }}, skipped=${{ needs.cleanup_orphaned_previews.outputs.skipped || '0' }}, unresolved=${{ needs.cleanup_orphaned_previews.outputs.unresolved || '0' }}"
                  fi

                  echo 'EOF'
                } >> "$GITHUB_OUTPUT"

            - uses: ./.dev-tools-actions/.github/actions/summary/write
              with:
                markdown: ${{ steps.build_summary.outputs.markdown }}