Run your PHPUnit tests in your Github Actions.

PHPUnit is a programmer-oriented testing framework for PHP.

It is an instance of the xUnit architecture for unit testing frameworks.

Usage

Create your Github Workflow configuration in .github/workflows/ci.yml or similar.

name: CI

on: [push]

jobs:
  build-test:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - uses: php-actions/composer@v5 # or alternative dependency management
    - uses: php-actions/phpunit@v2
    # ... then your own project steps ...

Example

We've put together an extremely simple example application that uses php-actions/phpunit. Check it out here: https://github.com/php-actions/example-phpunit.

Inputs

The following configuration options are available:

• version The version of PHPUnit to use e.g. 9 or 9.5.0 (default: latest)
• php_version The version of PHP to use e.g. 7.4 (default: latest)
• php_extensions Space-separated list of extensions using php-build e.g. xdebug mbstring (default: N/A)
• configuration Path to the phpunit.xml file (default: test/phpunit/phpunit.xml)
• log_junit Path to junit output file (default: test/phpunit/_junit/junit.xml)
• memory_limit The memory limit to run your tests with (default: 512M)
• bootstrap The path to the bootstrap file (default: vendor/autoload.php)

The syntax for passing in a custom input is the following:

...

jobs:
  unit-tests:

    ...

    - name: PHPUnit tests
      uses: php-actions/phpunit@v2
      with:
        configuration: custom/path/to/phpunit.xml
        memory_limit: 256M

If you require other configurations of phpunit, please request them in the Github issue tracker

PHP and PHPUnit versions

It's possible to run any version of PHPUnit under any version of PHP, with any PHP extensions you require. This is configured with the following inputs:

• version - the version number of PHPUnit to run e.g. 9 or 9.5.0 (default: latest)
• php_version - the version number of PHP to use e.g. 7.4 (default: latest)
• php_extensions - a space-separated list of extensions to install using php-build e.g. xdebug mbstring (default: N/A)

Please note the version number specified within your Action configuration must match your composer.json major version number. For example, if your composer.json requires phpunit/phpunit 8.5.8, you must use the version: 8.5.8 input, as major versions of PHPUnit are incompatible with each other.

If you require a specific version that is not compatible with Github Actions for some reason, please make a request in the Github issue tracker.

Github Actions releases

Previously, the Github Actions release version numbers were in sync with the PHPUnit version, but this imposed too many limitations. For the next 12 months (until 30th November 2021), v7, v8 and v9 branches will still point to their existing commits, but we have reverted to v1-based Actions releases, allowing PHPUnit version number to be specified from your configuration, using the version input variable.

---

If you found this repository helpful, please consider sponsoring the developer.