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 setup the PHP environment you need to test your application. Refer to Usage section and examples to see how to use this.

Contents

• PHP Support
• OS/Platform Support
  • GitHub-Hosted Runners
  • Self-Hosted Runners
• PHP Extension Support
• Tools Support
• Coverage Support
  • Xdebug
  • PCOV
  • Disable Coverage
• Usage
  • Inputs
  • Basic Setup
  • Matrix Setup
  • Nightly Build Setup
  • Self Hosted Setup
  • Local Testing Setup
  • Thread Safe Setup
  • Force Update
  • Verbose Setup
  • Cache Extensions
  • Cache Composer Dependencies
  • Cache Node.js Dependencies
  • Composer GitHub OAuth
  • Problem Matchers
  • Examples
• Versioning
• License
• Contributions
• Support This Project
• Dependencies
• Further Reading

🎉 PHP Support

PHP Version	Stability	Release Support	Runner Support
5.3	Stable	End of life	GitHub-hosted
5.4	Stable	End of life	GitHub-hosted
5.5	Stable	End of life	GitHub-hosted
5.6	Stable	End of life	GitHub-hosted, self-hosted
7.0	Stable	End of life	GitHub-hosted, self-hosted
7.1	Stable	End of life	GitHub-hosted, self-hosted
7.2	Stable	Security fixes only	GitHub-hosted, self-hosted
7.3	Stable	Active	GitHub-hosted, self-hosted
7.4	Stable	Active	GitHub-hosted, self-hosted
8.0	Nightly	In development	GitHub-hosted, self-hosted

Note: Specifying 8.0 in php-version input installs a nightly build of PHP 8.0.0-dev with PHP JIT, Union Types v2 and other new features. See nightly build setup for more information.

☁️ OS/Platform Support

Both GitHub-hosted runners and self-hosted runners are supported on the following operating systems.

GitHub-Hosted Runners

Virtual environment	YAML workflow label	Pre-installed PHP
Ubuntu 16.04	ubuntu-16.04	PHP 5.6 to PHP 7.4
Ubuntu 18.04	ubuntu-latest or ubuntu-18.04	PHP 7.1 to PHP 7.4
Ubuntu 20.04	ubuntu-20.04	PHP 7.4
Windows Server 2019	windows-latest or windows-2019	PHP 7.4
macOS Catalina 10.15	macos-latest or macos-10.15	PHP 7.4

Self-Hosted Runners

Host OS/Virtual environment	YAML workflow label
Ubuntu 16.04	self-hosted or Linux
Ubuntu 18.04	self-hosted or Linux
Ubuntu 20.04	self-hosted or Linux
Windows 7 and newer	self-hosted or Windows
Windows Server 2012 R2 and newer	self-hosted or Windows
macOS Catalina 10.15	self-hosted or macOS

• Refer to the self-hosted setup to use the action on self-hosted runners.

➕ PHP Extension Support

• On ubuntu by default extensions which are available as a package can be installed. PECL extensions if not available as a package can be installed by specifying pecl in the tools input.

- name: Setup PHP with pecl extension
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    tools: pecl
    extensions: swoole

• On windows PECL extensions which have the DLL binary can be installed.

• On macOS PECL extensions can be installed.

• Extensions installed along with PHP if specified are enabled.

• Specific versions of PECL extensions can be installed by suffixing 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'
    tools: pecl
    extensions: swoole-1.9.3

• Pre-release versions of PECL extensions can be setup by suffixing the extension 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: '7.4'
    tools: pecl
    extensions: xdebug-beta

• Shared extensions can be removed by prefixing them with a :.

- name: Setup PHP and remove shared extension
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'  
    extensions: :opcache

• Extension intl can be setup with specific ICU version for PHP 5.6 to PHP 7.4 in Ubuntu workflows by suffixing intl with the ICU version. ICU 50.2 and newer versions are supported. Refer to ICU builds for the specific versions supported.

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

• Extensions which cannot be added or removed gracefully leave an error message in the logs, the action is not interrupted.

• These extensions have custom support - cubrid, pdo_cubrid and gearman on Ubuntu, and blackfire, ioncube, oci8, pdo_oci, phalcon3 and phalcon4 on all supported OS.

🔧 Tools Support

These tools can be setup globally using the tools input.

behat, blackfire, blackfire-player, codeception, composer, composer-normalize, composer-prefetcher, composer-require-checker, composer-unused, cs2pr, deployer, flex, grpc_php_plugin, infection, pecl, phan, phing, phinx, phive, phpcbf, phpcpd, php-config, php-cs-fixer, phpcs, phpize, phpmd, phpspec, phpstan, phpunit, prestissimo, protoc, psalm, symfony, vapor-cli

- name: Setup PHP with tools
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    tools: php-cs-fixer, phpunit

To setup a particular version of a tool, specify it in the form tool:version.
Latest stable version of composer is setup by default. You can setup the required version by specifying v1, v2, snapshot or preview as version.

- name: Setup PHP with composer v2
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    tools: composer:v2

Latest versions of both agent blackfire-agent and client blackfire are setup when blackfire is specified in tools input. Please refer to the official documentation for using blackfire with GitHub Actions.

Version for other tools should be in semver format and a valid release of the tool.
This is useful for installing tools for older versions of PHP.
For example to setup PHPUnit on PHP 7.2.

- name: Setup PHP with tools
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.2'
    tools: phpunit:8.5.8

Notes

• This is useful to set up tools which you only use in GitHub Actions, thus keeping your composer.json tidy.
• If you have a tool in your composer.json, do not setup it globally using this action as the two instances of the tool might conflict.
• Tools which cannot be setup gracefully leave an error message in the logs, the action is not interrupted.

📶 Coverage Support

Xdebug

Specify coverage: xdebug to use Xdebug.
Runs on all PHP versions supported.

- name: Setup PHP with Xdebug
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    coverage: xdebug

PCOV

Specify coverage: pcov to use PCOV and disable Xdebug.
PCOV supports PHP 7.1 and newer PHP versions.
Tests with PCOV run much faster than with Xdebug.
If your source code directory is other than src, lib or, app, specify pcov.directory using the ini-values input.

- name: Setup PHP with PCOV
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    ini-values: pcov.directory=api #optional, see above for usage.
    coverage: pcov

PHPUnit 8 and above supports PCOV out of the box.
If you are using PHPUnit 5, 6 or 7, you will need krakjoe/pcov-clobber.
Before executing your tests add the following step.

- name: Setup PCOV
  run: |
    composer require pcov/clobber
    vendor/bin/pcov clobber    

Disable Coverage

Specify coverage: none to remove both Xdebug and PCOV.
Consider disabling the coverage using this PHP action for these reasons.

• You are not generating coverage reports while testing.
• It will remove Xdebug, which will have a positive impact on PHP performance.
• You are using phpdbg for running your tests.
• You are profiling your code using blackfire.

- name: Setup PHP with no coverage driver
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    coverage: none

📝 Usage

Inputs

php-version (required)

• Specify the PHP version you want to setup.
• Accepts a string. For example '7.4'.
• Accepts latest to set up the latest stable PHP version.
• See PHP support for supported PHP versions.

extensions (optional)

• Specify the extensions you want to add or remove.
• Accepts a string in csv-format. For example mbstring, :opcache.
• Non-default extensions prefixed with : are removed.
• See PHP extension support for more info.

ini-values (optional)

• Specify the values you want to add to php.ini.
• Accepts a string in csv-format. For example post_max_size=256M, short_open_tag=On.

coverage (optional)

• Specify the code coverage driver you want to setup.
• Accepts xdebug, pcov or none.
• See coverage support for more info.

tools (optional)

• Specify the tools you want to setup.
• Accepts a string in csv-format. For example phpunit, phpcs
• See tools Support for tools supported.

See below for more info.

Basic Setup

Setup a particular PHP version.

steps:
- name: Checkout
  uses: actions/checkout@v2

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    extensions: mbstring, intl
    ini-values: post_max_size=256M, short_open_tag=On
    coverage: xdebug    
    tools: php-cs-fixer, phpunit

Matrix Setup

Setup multiple PHP versions on multiple operating systems.

jobs:
  run:
    runs-on: ${{ matrix.operating-system }}
    strategy:
      matrix:
        operating-system: [ubuntu-latest, windows-latest, macos-latest]
        php-versions: ['5.6', '7.0', '7.1', '7.2', '7.3', '7.4']
    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
    steps:
    - name: Checkout
      uses: actions/checkout@v2

    - name: Setup PHP
      uses: shivammathur/setup-php@v2
      with:
        php-version: ${{ matrix.php-versions }}
        extensions: mbstring, intl
        ini-values: post_max_size=256M, short_open_tag=On
        coverage: xdebug        
        tools: php-cs-fixer, phpunit

Nightly Build Setup

Setup a nightly build of PHP 8.0.0-dev from the master branch of PHP.

• This version is currently in development.
• PECL is installed by default with this version on ubuntu and macOS.
• Some user space extensions might not support this version currently.
• Refer to this RFC for configuring PHP JIT on this version.
• Refer to this list of RFCs implemented in this version.

steps:
- name: Checkout
  uses: actions/checkout@v2

- name: Setup nightly PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.0'
    extensions: mbstring
    ini-values: opcache.jit_buffer_size=256M, opcache.jit=1235, pcre.jit=1
    coverage: pcov
    tools: php-cs-fixer, phpunit

Self Hosted Setup

Setup PHP on a self-hosted runner.

• To setup a dockerized self-hosted runner, refer to this guide to setup in an Ubuntu container and refer to this guide to setup in a Windows container.
• To setup the runner directly on the host OS or in a virtual machine, follow this requirements guide before setting up the self-hosted runner.
• If your workflow uses services, then setup the runner on a Linux host or in a Linux virtual machine. GitHub Actions does not support nested virtualization on Linux, so services will not work in a dockerized container.

Specify the environment variable runner with the value self-hosted. Without this your workflow will fail.

jobs:
  run:
    runs-on: self-hosted
    strategy:
      matrix:        
        php-versions: ['5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0']
    name: PHP ${{ matrix.php-versions }}
    steps:
    - name: Checkout
      uses: actions/checkout@v2

    - name: Setup PHP
      uses: shivammathur/setup-php@v2
      with:
        php-version: ${{ matrix.php-versions }}
      env:
        runner: self-hosted # Specify the runner.

Notes

• Do not setup multiple self-hosted runners on the a single server instance as parallel workflow will conflict with each other.
• Do not setup self-hosted runners on the side on your development environment or your production server.

Local Testing Setup

Test your Ubuntu workflow locally using nektos/act.

jobs:
  run:
    runs-on: ubuntu-latest
    name: PHP 7.4 Test
    steps:
    - name: Checkout
      uses: actions/checkout@v2

    - name: Setup PHP
      uses: shivammathur/setup-php@v2
      with:
        php-version: 7.4

Run the workflow locally with act using shivammathur/node docker image.

# For runs-on: ubuntu-latest
act -P ubuntu-latest=shivammathur/node:latest

# For runs-on: ubuntu-20.04
act -P ubuntu-20.04=shivammathur/node:focal

# For runs-on: ubuntu-18.04
act -P ubuntu-18.04=shivammathur/node:bionic

# For runs-on: ubuntu-16.04
act -P ubuntu-16.04=shivammathur/node:xenial

Thread Safe Setup

Setup both TS and NTS PHP on Windows.

• NTS versions are setup by default.
• On Ubuntu and macOS only NTS versions are supported.
• On Windows both TS and NTS versions are supported.

jobs:
  run:
    runs-on: windows-latest
    name: Setup PHP TS on Windows
    steps:
    - name: Checkout
      uses: actions/checkout@v2

    - name: Setup PHP
      uses: shivammathur/setup-php@v2
      with:
        php-version: '7.4'
      env:
        phpts: ts # specify ts or nts

Force Update

Update to latest patch of PHP versions.

• Pre-installed PHP versions on the GitHub Actions runner are not updated to their latest patch release by default.
• You can specify the update environment variable to true to force update to the latest release.

- name: Setup PHP with latest versions
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
  env:
    update: true # specify true or false

Verbose Setup

Debug your workflow

To debug any issues, you can use the verbose tag instead of v2.

- name: Setup PHP with logs
  uses: shivammathur/setup-php@verbose
  with:
    php-version: '7.4'

Cache Extensions

You can cache PHP extensions using shivammathur/cache-extensions and action/cache GitHub Actions. Extensions which take very long to setup when cached are available in the next workflow run and are enabled directly. This reduces the workflow execution time.
Refer to shivammathur/cache-extensions for details.

Cache Composer Dependencies

If your project uses composer, you can persist composer's internal cache directory. Dependencies cached are loaded directly instead of downloading them while installation. The files cached are available across check-runs and will reduce the workflow execution time.

- name: Get composer cache directory
  id: composercache
  run: echo "::set-output name=dir::$(composer config cache-files-dir)"

- name: Cache dependencies
  uses: actions/cache@v2
  with:
    path: ${{ steps.composercache.outputs.dir }}
    key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
    restore-keys: ${{ runner.os }}-composer-

- name: Install dependencies
  run: composer install --prefer-dist

Notes

• Please do not cache vendor directory using action/cache as that will have side-effects.
• In the above example, if you support a range of composer dependencies and do not commit composer.lock, you can use the hash of composer.json as the key for your cache.

key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}

Cache Node.js Dependencies

If your project has node.js dependencies, you can persist npm's or yarn's cache directory. The cached files are available across check-runs and will reduce the workflow execution time.

- name: Get node.js cache directory
  id: nodecache
  run: echo "::set-output name=dir::$(npm config get cache)" # Use $(yarn cache dir) for yarn

- name: Cache dependencies
  uses: actions/cache@v2
  with:
    path: ${{ steps.nodecache.outputs.dir }}
    key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} # Use '**/yarn.lock' for yarn
    restore-keys: ${{ runner.os }}-node-

Note: Please do not cache node_modules directory as that will have side-effects.

Composer GitHub OAuth

If you have a number of workflows which setup multiple tools or have many composer dependencies, you might hit the GitHub's rate limit for composer. To avoid that you can add an OAuth token to the composer's config by setting COMPOSER_TOKEN environment variable. You can use GITHUB_TOKEN secret for this purpose.

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
  env:
    COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Problem Matchers

Problem matchers are json configurations which identify errors and warnings in your logs and surface that information prominently in the GitHub Actions UI by highlighting them and creating code annotations.

PHP

Setup problem matchers for your PHP output by adding this step after the setup-php step.

- name: Setup problem matchers for PHP
  run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"

PHPUnit

Setup problem matchers for your PHPUnit output by adding this step after the setup-php step.

- name: Setup problem matchers for PHPUnit
  run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"

PHPStan

PHPStan supports error reporting in GitHub Actions, so no problem matchers are required.

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    tools: phpstan

- name: Run PHPStan
  run: phpstan analyse src

Psalm

Psalm supports error reporting in GitHub Actions with an output format github.

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    tools: psalm

- name: Run Psalm
  run: psalm --output-format=github

Tools with checkstyle support

For tools that support checkstyle reporting like phpstan, psalm, php-cs-fixer and phpcs you can use cs2pr to annotate your code.
For examples refer to cs2pr documentation.

Here is an example with phpcs.

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'
    tools: cs2pr, phpcs

- name: Run phpcs
  run: phpcs -q --report=checkstyle src | cs2pr

Examples

Examples of using setup-php with various PHP Frameworks and Packages.

Framework/Package	Runs on	Workflow
Blackfire	macOS, ubuntu and windows	blackfire.yml
Blackfire Player	macOS, ubuntu and windows	blackfire-player.yml
CakePHP with MySQL and Redis	ubuntu	cakephp-mysql.yml
CakePHP with PostgreSQL and Redis	ubuntu	cakephp-postgres.yml
CakePHP without services	macOS, ubuntu and windows	cakephp.yml
CodeIgniter	macOS, ubuntu and windows	codeigniter.yml
Laravel with MySQL and Redis	ubuntu	laravel-mysql.yml
Laravel with PostgreSQL and Redis	ubuntu	laravel-postgres.yml
Laravel without services	macOS, ubuntu and windows	laravel.yml
Lumen with MySQL and Redis	ubuntu	lumen-mysql.yml
Lumen with PostgreSQL and Redis	ubuntu	lumen-postgres.yml
Lumen without services	macOS, ubuntu and windows	lumen.yml
Phalcon with MySQL	ubuntu	phalcon-mysql.yml
Phalcon with PostgreSQL	ubuntu	phalcon-postgres.yml
Roots/bedrock	ubuntu	bedrock.yml
Roots/sage	ubuntu	sage.yml
Slim Framework	macOS, ubuntu and windows	slim-framework.yml
Symfony with MySQL	ubuntu	symfony-mysql.yml
Symfony with PostgreSQL	ubuntu	symfony-postgres.yml
Symfony without services	macOS, ubuntu and windows	symfony.yml
Yii2 Starter Kit with MySQL	ubuntu	yii2-mysql.yml
Yii2 Starter Kit with PostgreSQL	ubuntu	yii2-postgres.yml
Zend Framework	macOS, ubuntu and windows	zend-framework.yml

🔖 Versioning

• It is highly recommended to use the v2 tag as setup-php version. It is a rolling tag and is synced with latest minor and patch releases. With v2 you automatically get the bug fixes, new features and support for latest PHP releases. For debugging any issues verbose tag can be used temporarily. It outputs all the logs and is also synced with the latest releases.
• Semantic release versions can also be used. It is recommended to use dependabot with semantic versioning to keep the actions in your workflows up to date.
• Commit SHA can also be used, but are not recommended. They have to be updated with every release manually, without which you will not get any bug fixes or new features.
• Using the master branch as version is highly discouraged, it might break your workflow after major releases as they have breaking changes.
• If you are using the v1 tag or a 1.x.y version, it is recommended that you switch to v2 as v1 only gets critical bug fixes. Maintenance support for v1 will be dropped with the last PHP 8.0 release.

📜 License

• The scripts and documentation in this project are released under the MIT License.
• This project has multiple dependencies. Their licenses can be found in their respective repositories.
• The logo for setup-php is a derivative work of php.net logo and is licensed under the CC BY-SA 4.0 License.

👍 Contributions

Contributions are welcome!

• See Contributor's Guide before you start.
• If you face any issues while using this or want to suggest a feature/improvement, create an issue here.

Join the list of setup-php contributors

💖 Support This Project

• Please star the project and share it. If you blog, please share your experience of using this action.
• Please consider supporting our work by sponsoring using Open Collective, Paypal or Patreon.
• If you use setup-php at your company, please reach out to sponsor the project.

Huge thanks to the following companies for supporting setup-php

                   

📦 Dependencies

• Node.js dependencies
• gplessis/dotdeb-php
• mlocati/powershell-phpmanager
• ppa:ondrej/php
• shivammathur/cache-extensions
• shivammathur/composer-cache
• shivammathur/homebrew-extensions
• shivammathur/homebrew-php
• shivammathur/icu-intl
• shivammathur/php-builder
• shivammathur/php-builder-windows
• shivammathur/php-ubuntu
• shivammathur/php5-darwin
• shivammathur/php5-ubuntu

📑 Further Reading

• About GitHub Actions
• GitHub Actions Syntax
• Other Awesome Actions