moodle-ci.yaml

name: Moodle Plugin CI

on:
  push:
    branches:
      - main
    paths:
      - '**.feature'
      - '**.js'
      - '**.mustache'
      - '**.php'
      - '.github/workflows/*'
      - 'db/*'
  pull_request:
    paths:
      - '**.feature'
      - '**.js'
      - '**.mustache'
      - '**.php'
      - '.github/workflows/*'
      - 'db/*'
  schedule:
    # At 00:00 on the 1st of every month
    - cron: '0 0 1 * *'
  workflow_dispatch:

jobs:
  test:
    runs-on: ubuntu-22.04

    services:
      postgres:
        image: postgres:18
        env:
          POSTGRES_USER: 'postgres'
          POSTGRES_HOST_AUTH_METHOD: 'trust'
        ports:
          - 5432:5432
        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3

      mariadb:
        image: mariadb:10
        env:
          MYSQL_USER: 'root'
          MYSQL_ALLOW_EMPTY_PASSWORD: "true"
          MYSQL_CHARACTER_SET_SERVER: "utf8mb4"
          MYSQL_COLLATION_SERVER: "utf8mb4_unicode_ci"
        ports:
          - 3306:3306
        options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3

    strategy:
      fail-fast: false
      matrix:
        php: ['8.2', '8.3', '8.4']
        moodle-branch: ['MOODLE_500_STABLE', 'MOODLE_501_STABLE']
        database: [pgsql, mariadb]
        # In case more PHP/Moodle versions are added to the matrix, we may need to exclude some combinations.
        # See: https://moodledev.io/general/development/policies/php
        #exclude:
        #  - php: '8.3'
        #    moodle-branch: MOODLE_403_STABLE

    steps:
      - name: Check out repository code
        uses: actions/checkout@v6
        with:
          path: plugin

      - name: Setup PHP ${{ matrix.php }}
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php }}
          extensions: ${{ matrix.extensions }}
          ini-values: max_input_vars=5000
          coverage: pcov

      - name: Initialise moodle-plugin-ci
        run: |
          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
          echo $(cd ci/bin; pwd) >> $GITHUB_PATH
          echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
          sudo locale-gen en_AU.UTF-8
          echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV

      - name: Install moodle-plugin-ci
        run: moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
        env:
          DB: ${{ matrix.database }}
          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
          # Uncomment this to run Behat tests using the Moodle App.
          # MOODLE_APP: 'true'

      - name: PHP Lint
        if: ${{ !cancelled() }}
        run: moodle-plugin-ci phplint

      - name: PHP Mess Detector
        continue-on-error: true # This step will show errors but will not fail
        if: ${{ !cancelled() }}
        run: moodle-plugin-ci phpmd

      - name: Moodle Code Checker
        if: ${{ !cancelled() }}
        # As of now, moodle-cs incorrectly analyzes `readonly` classes and complains about the `MOODLE_INTERNAL` check missing for `final readonly` class definitions.
        # Until https://github.com/moodlehq/moodle-cs/pull/224 is merged (or the issue is fixed in another way), we have to ignore that sniff.
        run: moodle-plugin-ci phpcs --exclude='moodle.Files.MoodleInternal' --max-warnings 0
        #run: moodle-plugin-ci phpcs --max-warnings 0

      # This has too many false positives and will be replaced completely by the Moodle Code Sniffer soon (hopefully).
      #- name: Moodle PHPDoc Checker
      #  if: ${{ !cancelled() }}
      #  run: moodle-plugin-ci phpdoc --max-warnings 0

      - name: Validating
        if: ${{ !cancelled() }}
        run: moodle-plugin-ci validate

      - name: Check upgrade savepoints
        if: ${{ !cancelled() }}
        run: moodle-plugin-ci savepoints

      - name: Mustache Lint
        if: ${{ !cancelled() }}
        run: moodle-plugin-ci mustache

      - name: Grunt
        if: ${{ !cancelled() }}
        run: moodle-plugin-ci grunt --max-lint-warnings 0

      - name: PHPUnit tests
        if: ${{ !cancelled() }}
        run: moodle-plugin-ci phpunit --fail-on-warning

      - name: Behat features
        id: behat
        if: ${{ !cancelled() }}
        run: moodle-plugin-ci behat --profile chrome --scss-deprecations

      - name: Upload Behat Faildump
        if: ${{ failure() && steps.behat.outcome == 'failure' }}
        uses: actions/upload-artifact@v4
        with:
          name: Behat Faildump (${{ join(matrix.*, ', ') }})
          path: ${{ github.workspace }}/moodledata/behat_dump
          retention-days: 7
          if-no-files-found: ignore

      - name: Mark cancelled jobs as failed.
        if: ${{ cancelled() }}
        run: exit 1