Continuous integration for extensions #

This page is for application creators who want every push of their extension checked automatically. The kernel's own workflows in .github/workflows/ are a tested model (GitHub Actions workflows).

Contents #

1. What the kernel's CI does
2. A workflow for an extension
3. Testing against the kernel
4. Rules

What the kernel's CI does #

A workflow for an extension #

# .github/workflows/ci.yml
name: CI
on: [push, pull_request]
permissions:
  contents: read
jobs:
  lint:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        php: ['8.0', '8.1', '8.2', '8.3', '8.4', '8.5']
    steps:
      - uses: actions/checkout@v4
      - uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php }}
      - run: find . -name '*.php' -not -path './vendor/*' -print0 | xargs -0 -n1 php -l
  tests:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: shivammathur/setup-php@v2
        with:
          php-version: '8.3'
      - run: composer install --no-interaction
      - run: vendor/bin/phpunit tests/

Lint on every PHP version the kernel supports (8.0 to 8.5, Requirements), because installations run on all of them.

Testing against the kernel #

Tests that need kernel classes run in a checkout of se7enxweb/exponential with your extension placed in extension/: check out both, run composer install in the kernel, copy or link your extension, regenerate autoloads, then run your tests with the kernel's phpunit.xml bootstrap. Keep these tests DB-less where possible (DB-less PHPUnit tests).

Rules #

• Least privileges: permissions: contents: read; no pull_request_target.
• A timeout per job.
• Pin action versions; update them deliberately.
• No secrets in logs; secrets only where a job truly needs them, never on pull requests from forks.
• Red CI blocks the release tag (Versions and releases).

Related pages #

• Testing applications
• Quality checks
• CI behavior changes
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.