pre-commit.yml

---
name: pre-commit
on:
  pull_request:
  push:
jobs:
  pre-commit:
    runs-on: ubuntu-latest
    env:
      LOG_TO_CS: .github/logToCs.py
      RAW_LOG: pre-commit.log
      CS_XML: pre-commit.xml
    steps:
      - name: Install required tools
        run: sudo apt-get update && sudo apt-get install cppcheck
        if: false

      # The next uses the git API because there is no clone yet.
      # This is faster for a big repo.
      - name: Get all changed php files (if PR)
        id: changed-php
        uses: tj-actions/changed-files@v42
        if: github.event_name == 'pull_request'
        with:
          files: |
             **.php

      # Checkout git sources to analyze
      - uses: actions/checkout@v4
      # Action setup-python needs a requirements.txt or pyproject.toml
      # This ensures one of them exists.
      - name: Create requirements.txt if no requirements.txt or pyproject.toml
        run: |-
          [ -r requirements.txt ] || [ -r pyproject.toml ] || touch requirements.txt
      # Install python and pre-commit tool
      - uses: actions/setup-python@v5
        with:
          cache: pip
          python-version: '3.11'
      - run: python -m pip install pre-commit regex
      # Restore previous cache of precommit
      - uses: actions/cache/restore@v4
        with:
          path: ~/.cache/pre-commit/
          key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
      # Run all the precommit tools (defined into pre-commit-config.yaml).
      # We can force exclusion of some of them here.
      - name: Run pre-commit hooks
        env:
          # SKIP is used by pre-commit to not execute certain hooks
          SKIP: no-commit-to-branch,php-cs,php-cbf,trailing-whitespace,end-of-file-fixer,check-json,check-executables-have-shebangs,check-shebang-scripts-are-executable,beautysh,yamllint,shellcheck
        run: |
          set -o pipefail
          pre-commit gc
          pre-commit run --show-diff-on-failure --color=always --all-files | tee ${RAW_LOG}

      # The next uses git, which is slow for a bit repo.
      # - name: Get all changed php files (if PR)
      #   id: changed-php
      #   uses: tj-actions/changed-files@v42
      #   if: github.event_name == 'pull_request'
      #   with:
      #     files: |
      #        **.php

      - name: Setup PHPCS
        uses: shivammathur/setup-php@v2
        # Install when we're going to run phpcs
        if: |
         steps.changed-php.outputs.any_changed == 'true'
         ||
         (
           github.event_name == 'push'
           && (
                github.event.ref == 'refs/heads/develop'
              || endsWith(github.event.ref, '.0')
           )
         )
        with:
          php-version: 8.1
          coverage: none  # disable xdebug, pcov
          tools: phpcs

      - name: Run some pre-commit hooks on selected changed files only
        if: steps.changed-php.outputs.any_changed == 'true'
        env:
          ALL_CHANGED_FILES: ${{ steps.changed-php.outputs.all_changed_files }}
        run: |
          set -o pipefail
          pre-commit run php-cs --files ${ALL_CHANGED_FILES} | tee -a ${RAW_LOG}

      - name: Run some pre-commit hooks on all files on push to "main" branches
        if: |
         github.event_name == 'push'
         && (
              github.event.ref == 'refs/heads/develop'
            || endsWith(github.event.ref, '.0')
         )
        run: |
          set -o pipefail
          pre-commit run -a php-cs | tee -a ${RAW_LOG}

      # If error, we convert log in the checkstyle format
      - name: Convert Raw Log to CheckStyle format
        if: ${{ failure() }}
        run: |
          python ${LOG_TO_CS} ${RAW_LOG} ${CS_XML}
      # Annotate the git sources with the log messages
      - name: Annotate Source Code with Messages
        uses: staabm/annotate-pull-request-from-checkstyle-action@v1
        if: ${{ failure() }}
        with:
          files: ${{ env.CS_XML }}
          notices-as-warnings: true  # optional
          prepend-filename: true  # optional
      # Save the precommit cache
      - uses: actions/cache/save@v4
        if: ${{ ! cancelled() }}
        with:
          path: ~/.cache/pre-commit/
          key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml')
            }}
      # Upload result log files of precommit into the Artifact shared store
      - name: Provide log as artifact
        uses: actions/upload-artifact@v4
        if: ${{ ! cancelled() }}
        with:
          name: precommit-logs
          path: |
            ${{ env.RAW_LOG }}
            ${{ env.CS_XML }}
          retention-days: 2