ci.yml

name: "CI"
on:
  push:
    paths-ignore:
      - "README.md"
      - "LICENSE.md"
      - ".scruitinizer.yml"
      - ".editorconfig"
    branches: ["main"]
  pull_request:
    paths-ignore:
      - "README.md"
      - "LICENSE.md"
    branches: ["main"]

permissions:
  contents: "read"

jobs:
  test:
    runs-on: "ubuntu-latest"
    strategy:
      max-parallel: 2
      fail-fast: false
      matrix:
        php-version: [
          "8.1",
          "8.2",
          "8.3",
        ]
        composer-param: [
          "update --no-progress --prefer-dist --prefer-lowest",
          "update --no-progress --prefer-dist"
        ]
        experimental: [false]
        include:
          # also try a future version
          - php-version: "8.4"
            composer-param: "update --no-progress --prefer-dist --prefer-lowest"
            experimental: true
          - php-version: "8.4"
            composer-param: "update --no-progress --prefer-dist"
            experimental: true
    name: "PHP ${{ matrix.php-version }} test"
    steps:
      - name: "Check if PHP ${{ matrix.php-version }} is supported"
        if: "matrix.experimental == true"
        run: "echo 'PHP ${{ matrix.php-version }} is experimental'"
      - name: "checkout project"
        uses: "actions/checkout@v4"
        with:
          # needed by scrutinizer
          fetch-depth: 2

      - name: "Setup PHP"
        uses: "shivammathur/setup-php@v2"
        with:
          php-version: "${{ matrix.php-version }}"
          extensions: "bcmath"
          tools: "composer:v2"
          # needed by PHPUnit code coverage
          coverage: "pcov"

      - name: "Validate composer.json and composer.lock"
        run: "composer validate"
        continue-on-error: "${{ matrix.experimental }}"

      - name: "Get composer cache directory"
        id: "composer-cache"
        run: "echo \"dir=$(composer config cache-dir)\" >> $GITHUB_OUTPUT"
        continue-on-error: "${{ matrix.experimental }}"

      - name: "Cache composer dependencies"
        uses: "actions/cache@v4"
        with:
          path: "${{ steps.composer-cache.outputs.dir }}"
          key: "${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}"
          restore-keys: "${{ runner.os }}-composer-"
        continue-on-error: "${{ matrix.experimental }}"

      - name: "Install dependencies"
        run: "composer ${{ matrix.composer-param }}"
        continue-on-error: "${{ matrix.experimental }}"

      # Run phpunit with code coverage
      - name: "PHPUnit Tests"
        run: "vendor/bin/phpunit --coverage-clover=coverage.clover"
        continue-on-error: "${{ matrix.experimental }}"

        # Uploading reports for analysis
      - name: "Upload code-coverage to scrutinizer"
        run: "vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover"
        continue-on-error: "${{ matrix.experimental }}"

      - name: "Publish code coverage to Code Climate"
        uses: "paambaati/codeclimate-action@v5"
        env:
          CC_TEST_REPORTER_ID: "${{ secrets.CC_TEST_REPORTER_ID }}"
        with:
          coverageCommand: "vendor/bin/phpunit --coverage-clover=coverage.clover"
          coverageLocations: |
            coverage.clover:clover
        continue-on-error: "${{ matrix.experimental }}"

# vim: syntax=yaml ts=2 sw=2 et sr softtabstop=2 autoindent