Setup PHP in GitHub Actions

Setup PHP with required extensions, php.ini configuration, code-coverage support and various tools like composer in GitHub Actions. This action gives you a cross-platform interface to set up the PHP environment you need to test your application. Refer to Usage section and examples to see how to use this.

Contents

• OS/Platform Support
• GitHub-Hosted Runners
• Self-Hosted Runners
• PHP Support
• PHP Extension Support
• Tools Support
• Coverage Support
• Xdebug
• PCOV
• Disable Coverage
• Usage
• Inputs
• Outputs
• Flags
• Basic Setup
• Matrix Setup
• Nightly Build Setup
• Debug Build Setup
• Thread Safe Setup
• Force Update Setup
• Verbose Setup
• Multi-Arch Setup
• Self Hosted Setup
• Local Testing Setup
• JIT Configuration
• Cache Extensions
• Cache Composer Dependencies
• GitHub Composer Authentication
• Private Packagist Authentication
• Manual Composer Authentication
• Inline PHP Scripts
• Problem Matchers
• Examples
• Versioning
• License
• Contributions
• Support This Project
• Dependencies
• Further Reading

:cloud: OS/Platform Support

Both GitHub-hosted and self-hosted runners are supported by setup-php on the following OS/Platforms.

GitHub-Hosted Runners

Self-Hosted Runners

• Refer to the self-hosted setup to use the action on self-hosted runners.
• Operating systems based on the above Ubuntu and Debian versions are also supported on best effort basis.
• If the requested PHP version is pre-installed, setup-php switches to it, otherwise it installs the PHP version.

:tada: PHP Support

On all supported OS/Platforms, the following PHP versions can be set up as per the runner.

• PHP 5.3 to PHP 8.6 on GitHub-hosted runners, except for macOS ARM64 runners (macos-14).
• PHP 5.6 to PHP 8.6 on GitHub-hosted macOS ARM64 runners (macos-14).
• PHP 5.6 to PHP 8.6 on self-hosted runners.

[!Note] - Specifying 8.6 in php-version input installs a nightly build of PHP 8.6.0-dev from the master branch of PHP. See nightly build setup for more information. - To use JIT on PHP 8.0 and above, refer to the JIT configuration section.

:heavy_plus_sign: PHP Extension Support

PHP extensions can be set up using the extensions input. It accepts a string in csv-format.

• On Ubuntu, extensions which are available as a package, available on PECL or a git repository can be set up.

- name: Setup PHP with PECL extension
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.5'
    extensions: imagick, redis

• On Windows, extensions available on PECL which have the DLL binary can be set up.

• On macOS, extensions available on PECL or a git repository can be set up.

• On Ubuntu and macOS to compile and install an extension from a git repository follow this guide.

• Extensions installed along with PHP if specified are enabled.

• Specific versions of extensions available on PECL can be set up by suffixing the extension's name with the version. This is useful for installing old versions of extensions which support end of life PHP versions.

- name: Setup PHP with specific version of PECL extension
  uses: shivammathur/setup-php@v2
  with:
    php-version: '5.4'
    extensions: swoole-1.9.3

• Extensions with pre-release versions available on PECL can be set up by suffixing the extension's name with its state i.e alpha, beta, devel or snapshot.

- name: Setup PHP with pre-release PECL extension
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.5'
    extensions: xdebug-beta

• On Ubuntu and macOS to compile and install an extension from PECL with libraries or custom configuration follow this guide.

• Shared extensions can be disabled by prefixing them with a :. All extensions depending on the specified extension will also be disabled.

- name: Setup PHP and disable opcache
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.5'
    extensions: :mbstring

• All shared extensions can be disabled by specifying none. When none is specified along with other extensions, it is hoisted to the start of the input. So, all the shared extensions will be disabled first, then rest of the extensions in the input will be processed.

This disables all core and third-party shared extensions and thus, can break some tools that need them. Required extensions are enabled again when the tools are set up on a best-effort basis. So it is recommended to add the extensions required for your tools after none in the extensions input to avoid any issues.

- name: Setup PHP without any shared extensions except mbstring
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.5'
    extensions: none, mbstring

• Extension intl can be set up with specific ICU version for PHP 5.6 and above in Ubuntu workflows by suffixing intl with the ICU version. ICU 50.2 and newer versions are supported for PHP 8.4 and lower, ICU 57.2 and newer versions are supported for PHP 8.5 and above. Refer to ICU builds for the specific versions supported.

- name: Setup PHP with intl
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.5'
    extensions: intl-77.1

• Extensions loaded by default after setup-php runs can be found on the wiki.

• These extensions have custom support:

• cubrid and pdo_cubrid on Ubuntu.
• event, gearman, geos and relay on Ubuntu and macOS.

• blackfire, couchbase, ibm_db2, ioncube, oci8, pdo_firebird, pdo_ibm, pdo_oci, pecl_http, phalcon3, phalcon4, phalcon5, and zephir_parser on all supported OS.

• By default, extensions which cannot be added or disabled gracefully leave an error message in the logs, the execution is not interrupted. To change this behaviour you can set fail-fast flag to true.

- name: Setup PHP with fail-fast
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.5'
    extensions: oci8
  env:
    fail-fast: true

:wrench: Tools Support

These tools can be set up globally using the tools input. It accepts a string in csv-format.

[backward-compatibility-check], [behat], [blackfire], [blackfire-player], [box], [castor], [churn], [codeception], [composer], [composer-dependency-analyser], [composer-normalize], [composer-prefetcher], [composer-require-checker], [composer-unused], [cs2pr], [deployer], [ecs], [flex], [grpc_php_plugin], [infection], [mago], [name-collision-detector], [parallel-lint], [pecl], [phan], [phing], [phinx], [phive], [php-config], [php-cs-fixer], [php-scoper], [phpcbf], [phpcpd], [phpcs], [phpdoc] or [phpDocumentor], [phpize], [phplint], [phpmd], [phpspec], [phpstan], [phpunit], [phpunit-bridge], [phpunit-polyfills], [pie], [pint], [prestissimo], [protoc], [psalm], [rector], [symfony] or [symfony-cli], [vapor] or [vapor-cli], [wp] or [wp-cli]

```yaml - name: Setup PHP with tools uses: shivam