continuous-integration.yml

# GitHub Actions Documentation: https://docs.github.com/en/actions

name: "build"

on:
  push:
    branches:
      - "main"
    tags:
      - "*"
  pull_request:
    branches:
      - "main"

# Cancels all previous workflow runs for the same branch that have not yet completed.
concurrency:
  # The concurrency group contains the workflow name and the branch name.
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  COMPOSER_ROOT_VERSION: "1.99.99"

jobs:
  coding-standards:
    name: "Coding standards"
    runs-on: "ubuntu-latest"
    steps:
      - name: "Checkout repository"
        uses: "actions/checkout@v4.1.1"

      - name: "Install PHP"
        uses: "shivammathur/setup-php@2.30.5"
        with:
          php-version: "latest"
          extensions: "bcmath, ctype, gmp"
          coverage: "none"

      - name: "Install dependencies (Composer)"
        uses: "ramsey/composer-install@2.2.0"

      - name: "Check syntax (php-parallel-lint)"
        run: "composer dev:lint:syntax"

      - name: "Check coding standards (PHP_CodeSniffer)"
        run: "composer dev:lint:style"

  static-analysis:
    name: "Static analysis"
    runs-on: "ubuntu-latest"

    steps:
      - name: "Checkout repository"
        uses: "actions/checkout@v4.1.1"

      - name: "Install PHP"
        uses: "shivammathur/setup-php@2.30.5"
        with:
          php-version: "latest"
          extensions: "bcmath, ctype, gmp"
          coverage: "none"

      - name: "Install dependencies (Composer)"
        uses: "ramsey/composer-install@2.2.0"

      - name: "Statically analyze code (PHPStan)"
        run: "composer dev:analyze:phpstan"

      - name: "Statically analyze code (Psalm)"
        run: "composer dev:analyze:psalm -- --shepherd"

  security-analysis:
    name: "Security analysis"
    needs: ["coding-standards", "static-analysis"]
    runs-on: "ubuntu-latest"

    steps:
      - name: "Checkout repository"
        uses: "actions/checkout@v4.1.1"

      - name: "Install PHP"
        uses: "shivammathur/setup-php@2.30.5"
        with:
          php-version: "latest"
          extensions: "bcmath, ctype, gmp"
          coverage: "none"

      - name: "Install dependencies (Composer)"
        uses: "ramsey/composer-install@2.2.0"

      - name: "Analyze security of code (Psalm)"
        run: "./vendor/bin/psalm --taint-analysis --report=build/logs/psalm.sarif"

      - name: "Upload security analysis results to GitHub"
        uses: "github/codeql-action/upload-sarif@v3"
        with:
          sarif_file: "build/logs/psalm.sarif"

  code-coverage:
    name: "Code coverage"
    needs: ["coding-standards", "static-analysis"]
    runs-on: "ubuntu-latest"

    strategy:
      fail-fast: false
      matrix:
        composer-deps: [ "lowest", "highest" ]

    steps:
      - name: "Checkout repository"
        uses: "actions/checkout@v4.1.1"

      - name: "Install PHP"
        uses: "shivammathur/setup-php@2.30.5"
        with:
          php-version: "latest"
          extensions: "bcmath, ctype, gmp"
          coverage: "pcov"
          ini-values: "memory_limit=-1"

      - name: "Install dependencies (Composer)"
        uses: "ramsey/composer-install@2.2.0"
        with:
          dependency-versions: "${{ matrix.composer-deps }}"

      - name: "Run unit tests (PHPUnit)"
        if: "${{ matrix.composer-deps == 'highest' }}"
        run: "composer dev:test:coverage:ci"

      - name: "Run unit tests, with deprecation notices turned off (PHPUnit)"
        if: "${{ matrix.composer-deps == 'lowest' }}"
        run: "composer dev:test:coverage:ci -- -d 'error_reporting=E_ALL & ~E_DEPRECATED'"

      - name: "Publish coverage report to Codecov"
        uses: "codecov/codecov-action@v3.1.4"

  unit-tests:
    name: "Unit tests"
    needs: ["code-coverage"]
    runs-on: "ubuntu-latest"

    strategy:
      fail-fast: false
      matrix:
        php:
          - "7.4"
          - "8.0"
          - "8.1"
          - "8.2"
          - "8.3"
        composer-deps: ["lowest", "highest"]

    steps:
      - name: "Checkout repository"
        uses: "actions/checkout@v4.1.1"

      - name: "Install PHP"
        uses: "shivammathur/setup-php@2.30.5"
        with:
          php-version: "${{ matrix.php }}"
          extensions: "bcmath, ctype, gmp"
          coverage: "none"

      - name: "Install dependencies (Composer)"
        uses: "ramsey/composer-install@2.2.0"
        with:
          dependency-versions: "${{ matrix.composer-deps }}"

      - name: "Run unit tests (PHPUnit)"
        if: "${{ matrix.composer-deps == 'highest' }}"
        run: "composer dev:test:unit"

      - name: "Run unit tests, with deprecation notices turned off (PHPUnit)"
        if: "${{ matrix.composer-deps == 'lowest' }}"
        run: "composer dev:test:unit -- -d 'error_reporting=E_ALL & ~E_DEPRECATED'"