unsupervised-scheduler/.gitea/workflows/ci.yml

name: CI

on:
  push:
    branches:
      - main
      - develop
  pull_request:

# Jobs that need PHP run inside the shared CI images maintained in the
# Unsupervised/ci-php repository. PHP, Composer, the intl and zip extensions
# and the GNU CLI tools are already in the image, so there is no toolchain
# setup step in any job here.
#
# The registry path is written out at each use because
# jobs.<id>.container.image cannot read the `env` context.

jobs:
  phpcs:
    name: Coding Standards
    runs-on: ubuntu-latest
    container:
      image: git.unsupervised.ca/unsupervised/ci-php:8.3
    steps:
      - uses: actions/checkout@v4

      # COMPOSER_HOME is /composer in the image, so that is where the
      # download cache lives. composer.lock is what fingerprints the
      # dependency set.
      - name: Cache Composer packages
        uses: actions/cache@v4
        with:
          path: /composer/cache
          key: composer-${{ hashFiles('composer.lock') }}

      - name: Install dependencies
        run: composer install --prefer-dist --no-progress --no-interaction

      - name: Run PHPCS
        run: composer cs

  phpstan:
    name: Static Analysis
    runs-on: ubuntu-latest
    container:
      image: git.unsupervised.ca/unsupervised/ci-php:8.3
    steps:
      - uses: actions/checkout@v4

      - name: Cache Composer packages
        uses: actions/cache@v4
        with:
          path: /composer/cache
          key: composer-${{ hashFiles('composer.lock') }}

      - name: Install dependencies
        run: composer install --prefer-dist --no-progress --no-interaction

      - name: Run PHPStan
        run: composer lint

  test:
    name: Tests (PHP ${{ matrix.php }})
    runs-on: ubuntu-latest
    container:
      image: git.unsupervised.ca/unsupervised/ci-php:${{ matrix.php }}
    strategy:
      fail-fast: false
      matrix:
        # A version can only be added here once ci-php publishes the matching
        # tag.
        php:
          - '8.1'
          - '8.2'
          - '8.3'
          - '8.5'
    steps:
      - uses: actions/checkout@v4

      - name: Cache Composer packages
        uses: actions/cache@v4
        with:
          path: /composer/cache
          key: ${{ matrix.php }}-composer-${{ hashFiles('composer.lock') }}

      - name: Install dependencies
        run: composer install --prefer-dist --no-progress --no-interaction

      - name: Run PHPUnit
        run: composer test

  # Runs on the runner image rather than a container: it needs no PHP, and it
  # uses GNU grep's --include.
  no-debug:
    name: No Debug Code
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Check for debug statements
        run: |
          # \b keeps method calls like DateTimeImmutable::add() from matching dd(.
          if grep -rn --include="*.php" -E "\b(var_dump|var_export|print_r|error_log|dd|dump)\s*\(" src/; then
            echo "Debug code found in src/ — please remove before merging."
            exit 1
          fi

  build:
    name: Build Plugin Zip
    runs-on: ubuntu-latest
    container:
      image: git.unsupervised.ca/unsupervised/ci-php:8.3
    # Only build a shippable artifact once changes land on main, and only
    # after the quality gates pass.
    needs: [phpcs, phpstan, test, no-debug]
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    steps:
      - uses: actions/checkout@v4

      - name: Build plugin zip
        run: composer build

      - name: Read plugin version
        id: meta
        run: |
          version="$(sed -nE 's/^[[:space:]]*\*?[[:space:]]*Version:[[:space:]]*([^[:space:]]+).*/\1/p' unsupervised-schedular.php | head -1)"
          echo "version=${version}" >> "$GITHUB_OUTPUT"

      # Gitea/Actions re-zips artifacts on download. Upload the unpacked plugin
      # folder (not the built zip) so the downloaded archive's top level is
      # unsupervised-schedular/ and installs directly in WordPress. Uploading
      # the zip instead double-wraps it ("No valid plugins were found").
      - name: Unpack plugin for artifact
        run: unzip -q "dist/unsupervised-schedular-${{ steps.meta.outputs.version }}.zip" -d artifact

      - name: Upload artifact
        uses: actions/upload-artifact@v3
        with:
          name: unsupervised-schedular-${{ steps.meta.outputs.version }}
          path: artifact/
          if-no-files-found: error