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
- 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
Both GitHub-hosted and self-hosted runners are supported by setup-php on the following OS/Platforms. GitHub-Hosted Runners
Virtual environment | YAML workflow label | Pre-installed PHP |
---|
Ubuntu 22.04
| ubuntu-22.04
| PHP 8.1
| Ubuntu 20.04
| ubuntu-latest or ubuntu-20.04
| PHP 7.4 to PHP 8.1
| Ubuntu 18.04
| ubuntu-18.04
| PHP 7.2 to PHP 8.1
| Windows Server 2022
| windows-latest or windows-2022
| PHP 8.1
| Windows Server 2019
| windows-2019
| PHP 8.1
| macOS Monterey 12.x
| macos-12
| PHP 8.1
| macOS Big Sur 11.x
| macos-latest or macos-11
| PHP 8.1
| macOS Catalina 10.15
| macos-10.15
| PHP 8.1
|
Self-Hosted Runners
Host OS/Virtual environment | YAML workflow label |
---|
Ubuntu 22.04
| self-hosted or Linux
| Ubuntu 20.04
| self-hosted or Linux
| Ubuntu 18.04
| self-hosted or Linux
| Debian 11
| self-hosted or Linux
| Debian 10
| self-hosted or Linux
| Windows 7 and newer
| self-hosted or Windows
| Windows Server 2012 R2 and newer
| self-hosted or Windows
| macOS Monterey 12.x x86_64/arm64
| self-hosted or macOS
| macOS Big Sur 11.x x86_64/arm64
| self-hosted or macOS
| macOS Catalina 10.15
| self-hosted or macOS
|
- 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.
🎉 PHP SupportOn all supported OS/Platforms the following PHP versions are supported as per the runner. - PHP 5.3 to PHP 8.2 on GitHub-hosted runners.
- PHP 5.6 to PHP 8.2 on self-hosted runners.
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
| End of life
| GitHub-hosted , self-hosted
| 7.3
| Stable
| End of life
| GitHub-hosted , self-hosted
| 7.4
| Stable
| Security fixes only
| GitHub-hosted , self-hosted
| 8.0
| Stable
| Active
| GitHub-hosted , self-hosted
| 8.1
| Stable
| Active
| GitHub-hosted , self-hosted
| 8.2
| Nightly
| In development
| GitHub-hosted , self-hosted
|
Notes: - Specifying
8.2 in php-version input installs a nightly build of PHP 8.2.0-dev . See nightly build setup for more information. - To use JIT on
PHP 8.0 and above, refer to the JIT configuration
section.
➕ PHP Extension SupportPHP 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.1'
extensions: imagick, swoole 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.1'
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.1'
extensions: :opcache - 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.
Note: This disables all core and third-party shared extensions and thus, can break some tools which 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.1'
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. Refer to ICU builds for the specific versions supported.
- name: Setup PHP with intl
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
extensions: intl-70.1 Extensions loaded by default after setup-php runs can be found on the
wiki. These extensions have custom support: cubrid , pdo_cubrid and gearman on Ubuntu .geos and event on Ubuntu and macOS .blackfire , couchbase , ioncube , oci8 , pdo_firebird , pdo_oci , pecl_http , phalcon3 , phalcon4 and phalcon5 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.1'
extensions: oci8
env:
fail-fast: true These tools can be set up globally using the tools input. It accepts a string in csv-format. behat , blackfire , blackfire-player , churn ,
codeception , composer , composer-normalize , composer-prefetcher , composer-require-checker ,
composer-unused , cs2pr , deployer , flex , grpc_php_plugin ,
infection , parallel-lint , pecl , phan , phing , phinx , phive , php-config , php-cs-fixer , phpcbf , phpcpd ,
phpcs , phpdoc or phpDocumentor , phpize , phplint , phpmd , phpspec , phpstan , phpunit , phpunit-bridge , phpunit-polyfills , pint ,
prestissimo , protoc , psalm , rector , symfony or
symfony-cli , vapor or vapor-cli , wp or wp-cli
- name: Setup PHP with tools
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
tools: php-cs-fixer, phpunit - In addition to above tools any composer tool or package can also be set up globally by specifying it as
vendor/package matching the listing on Packagist. This format accepts the same version constraints as composer .
- name: Setup PHP with tools
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
tools: vimeo/psalm To set up a particular version of a tool, specify it in the form tool:version . Version can be in the following format: - Semver. For example
tool:1.2.3 or tool:1.2.3-beta1 . - Major version. For example
tool:1 or tool:1.x . - Major and minor version. For
example
tool:1.2 or tool:1.2.x .
When you specify just the major version or the version in major.minor format, the latest patch version matching the input will be setup. Except for major versions of composer , For other tools when you specify only the major version or the version in major.minor format for any tool you can get rate limited by GitHub's API. To avoid this, it is recommended to provide a
GitHub OAuth token. You can do that by setting GITHUB_TOKEN environment variable. The COMPOSER_TOKEN environment variable has been deprecated in favor of GITHUB_TOKEN and will be removed in the next major version.
- name: Setup PHP with tools
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
tools: php-cs-fixer:3.5, phpunit:9.5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - The latest stable version of
composer is set up by default. You can set up the required composer version by specifying the major version v1 or v2 , or the version in major.minor or semver format. Additionally for composer snapshot and preview can also be specified to set up the respective releases.
- name: Setup PHP with composer v2
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
tools: composer:v2 - If you do not use composer in your workflow, you can specify
tools: none to skip it.
- name: Setup PHP without composer
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
tools: none Tools pear , pecl , phpize and php-config are set up by default for all
supported PHP versions on Linux and macOS. The latest version of blackfire cli is set up when blackfire is specified in tools input. Please refer to the official documentation for using blackfire with GitHub Actions. Tools prestissimo and composer-prefetcher will be skipped unless composer:v1 is also specified
in tools input. It is recommended to drop prestissimo and use composer v2 . By default, expect composer tools which cannot be set up 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.1'
tools: deployer
env:
fail-fast: true
Notes - Input
tools is useful to set up tools which are only used in CI workflows, thus keeping your composer.json tidy. - If you do not want to use all your dev-dependencies in workflow, you can run composer with
--no-dev and install required tools using tools input to speed up your workflow. - By default,
COMPOSER_NO_INTERACTION is set to 1 and COMPOSER_PROCESS_TIMEOUT is set to 0 . In effect, this means that Composer commands in your scripts
do not need to specify --no-interaction .
📶 Coverage SupportXdebugSpecify coverage: xdebug to use Xdebug and disable PCOV . Runs on all PHP versions
supported. - name: Setup PHP with Xdebug
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
coverage: xdebug - When you specify
coverage: xdebug , the latest version of Xdebug compatible with the PHP version is set up by default. - If you need Xdebug 2.x on PHP 7.2, 7.3 or 7.4, you can specify
coverage: xdebug2 .
- name: Setup PHP with Xdebug 2.x
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
coverage: xdebug2 Note: Xdebug is enabled by default on Ubuntu GitHub Actions images, so if you are not using it in your workflow it is recommended to disable it as that will have a positive impact on your PHP performance. Please refer to the disable coverage section for details. PCOV
Specify coverage: pcov to use PCOV and disable Xdebug . Runs on PHP 7.1 and newer PHP versions. - 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: '8.1'
ini-values: pcov.directory=api #optional, see above for usage.
coverage: pcov
- PHPUnit 8.x and above supports PCOV out of the box.
- If you are using PHPUnit 5.x, 6.x or 7.x, you need to set up
pcov/clobber before executing your tests.
- name: Setup PCOV
run: |
composer require pcov/clobber
vendor/bin/pcov clobber Disable CoverageSpecify coverage: none to disable both Xdebug and PCOV . Disable coverage for these reasons: - You are not generating coverage reports while testing.
- You are using
phpdbg for running your tests. - You are profiling your code using
blackfire . - You are using PHP in JIT mode. Please refer to JIT configuration section for more details.
- name: Setup PHP with no coverage driver
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
coverage: none 📝 UsageInputsSpecify using with keyword
php-version (required)
- Specify the PHP version you want to set up.
- Accepts a
string . For example '8.0' . - Accepts
latest
to set up the latest stable PHP version. - Accepts
nightly to set up a nightly build from the master branch of PHP. - Accepts the format
d.x , where d is the major version. For example 5.x , 7.x and 8.x . - See PHP support for supported PHP versions.
extensions (optional)
- Specify the extensions you want to
add or disable.
- Accepts a
string in csv-format. For example mbstring, :opcache . - Accepts
none to disable all shared extensions. - Shared extensions prefixed with
: are disabled. - See PHP extension support for more info.
ini-file (optional)
- Specify the base
php.ini file. - Accepts
production ,
development or none . - By default, production
php.ini file is used.
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, max_execution_time=180 . - Accepts ini values with commas if wrapped in quotes. For example
xdebug.mode="develop,coverage" .
coverage (optional)
- Specify the code-coverage driver you want to set up.
- Accepts
xdebug , pcov or
none . - See coverage support for more info.
tools (optional)
- Specify the tools you want to set up.
- Accepts a
string in csv-format. For example: phpunit, phpcs - See tools support for tools
supported.
Outputsphp-version
On GitHub Actions you can assign the setup-php step an id , you can use the same to get the outputs in a later step. - Provides the PHP version in semver format.
- name: Setup PHP
id: setup-php
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
- name: Print PHP version
run: echo ${{ steps.setup-php.outputs.php-version }} FlagsSpecify using env keyword
fail-fast (optional)
- Specify to mark the workflow as failed if an extension or tool fails to set up.
- This changes the default mode from graceful warnings to fail-fast.
- By default, it is set to
false . - Accepts
true and false .
phpts (optional)
- Specify to set up thread-safe version of PHP on Windows.
- Accepts
ts and nts . - By default, it is set to
nts . - See thread safe setup for more info.
update (optional)
- Specify to update PHP on the runner to the latest patch version.
- Accepts
true and false . - By default, it is
set to
false . - See force update setup for more info.
See below for more info. Basic SetupSet up a particular PHP version.
steps:
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
extensions: mbstring, intl
ini-values: post_max_size=256M, max_execution_time=180
coverage: xdebug
tools: php-cs-fixer, phpunit Matrix SetupSet up 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: ['7.4', '8.0', '8.1']
phpunit-versions: ['latest']
include:
- operating-system: 'ubuntu-latest'
php-versions: '7.2'
phpunit-versions: '8.5.21'
steps:
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php-versions }}
extensions: mbstring, intl
ini-values: post_max_size=256M, max_execution_time=180
coverage: xdebug
tools: php-cs-fixer, phpunit:${{ matrix.phpunit-versions }} Nightly Build SetupSet up a nightly build of PHP 8.2 .
- This PHP version is currently in active development and might contain bugs and breaking changes.
- Some user space extensions might not support this version currently.
steps:
- name: Setup nightly PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'
extensions: mbstring
ini-values: post_max_size=256M, max_execution_time=180
coverage: xdebug
tools: php-cs-fixer, phpunit Thread Safe Setup
Set up TS or NTS PHP on Windows .
NTS versions are set up 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: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
env:
phpts: ts # specify ts or nts Force Update SetupUpdate to the latest patch of PHP versions.
- Pre-installed PHP versions are not updated to their latest patch release by default.
- You can specify the
update environment variable to true for updating to the latest release.
- name: Setup PHP with latest versions
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
env:
update: true # specify true or false Verbose SetupDebug 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: '8.1' Multi-Arch SetupSet up PHP on multiple architecture on Ubuntu GitHub Runners.
PHP 5.6 to PHP 8.1 are supported by setup-php on multiple architecture on Ubuntu .- For this, you can use
shivammathur/node images as containers. These have compatible Nodejs installed for setup-php . - Currently, for
ARM based setup, you will need self-hosted runners.
jobs:
run:
runs-on: ubuntu-latest
container: shivammathur/node:latest-${{ matrix.arch }}
strategy:
matrix:
arch: ["amd64", "i386"]
steps:
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1' Self Hosted SetupSet up PHP on a self-hosted runner.
To set up a containerised self-hosted runner,
refer to the following guides as per your base operating system. To set up 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 service containers, then set up 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.
It is recommended to specify the environment variable runner with the value self-hosted for self-hosted environments. 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: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php-versions }}
env:
runner: self-hosted Notes - Do not set up multiple self-hosted runners on a single server instance as parallel workflow will conflict with each other.
- Do not set up self-hosted runners on the side on your development environment or your production server.
- Avoid using the same labels for
your
self-hosted runners which are used by GitHub-hosted runners.
Local Testing SetupTest your Ubuntu workflow locally using nektos/act .
jobs:
run:
runs-on: ubuntu-latest
steps:
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1' Run the workflow locally with act using shivammathur/node docker images. Choose the image tag which matches the runs-on property in your workflow. For example, if you are using ubuntu-20.04 in your workflow, run act -P ubuntu-20.04=shivammathur/node:2004 . # For runs-on: ubuntu-latest
act -P ubuntu-latest=shivammathur/node:latest
# For runs-on: ubuntu-22.04
act -P ubuntu-22.04=shivammathur/node:2204
# For runs-on: ubuntu-20.04
act -P ubuntu-20.04=shivammathur/node:2004
# For runs-on: ubuntu-18.04
act -P ubuntu-18.04=shivammathur/node:1804 JIT ConfigurationEnable Just-in-time (JIT) on PHP 8.0 and above.
- To enable JIT, enable
opcache in cli mode by setting opcache.enable_cli=1 . - JIT conflicts with
Xdebug , PCOV , and other extensions which
override zend_execute_ex function, so set coverage: none and disable any such extension if added. - By default,
opcache.jit=1235 and opcache.jit_buffer_size=256M are set which can be changed using ini-values input. - For detailed information about JIT related directives refer to the
official PHP documentation .
For example to enable JIT in tracing mode with buffer size of
64 MB . - name: Setup PHP with JIT in tracing mode
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
coverage: none
ini-values: opcache.enable_cli=1, opcache.jit=tracing, opcache.jit_buffer_size=64M Cache ExtensionsYou can cache PHP extensions using shivammathur/cache-extensions and action/cache GitHub Actions. Extensions which take very long to set up 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 DependenciesIf your project uses composer, you can persist the 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: composer-cache
run: echo "::set-output name=dir::$(composer config cache-files-dir)"
- name: Cache dependencies
uses: actions/cache@v2
with:
path: ${{ steps.composer-cache.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. - If you 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') }} - If you support a range of
composer dependencies
and use prefer-lowest and prefer-stable options, you can store them in your matrix and add them to the keys.
key: ${{ runner.os }}-composer-${{ matrix.prefer }}-${{ hashFiles('**/composer.lock') }}
restore-keys: ${{ runner.os }}-composer-${{ matrix.prefer }}- GitHub Composer AuthenticationIf you have a number of workflows which set up multiple tools or have many composer dependencies, you might
hit the GitHub's rate limit for composer. Also, if you specify only the major version or the version in major.minor format, you can hit the rate limit. To avoid this you can specify an OAuth token by setting GITHUB_TOKEN environment variable. You can use GITHUB_TOKEN secret for this purpose. The COMPOSER_TOKEN environment
variable has been deprecated in favor of GITHUB_TOKEN and will be removed in the next major version. - name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} Private Packagist AuthenticationIf you use Private Packagist for your private composer dependencies, you can set the PACKAGIST_TOKEN environment variable to authenticate. - name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
env:
PACKAGIST_TOKEN: ${{ secrets.PACKAGIST_TOKEN }} Manual Composer AuthenticationIn addition to GitHub or Private Packagist, if you want to authenticate private repositories hosted elsewhere, you can set the COMPOSER_AUTH_JSON environment variable with the authentication methods and the credentials in json format. Please refer to the
authentication section in composer documentation for more details. - name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
env:
COMPOSER_AUTH_JSON: |
{
"http-basic": {
"example.org": {
"username": "${{ secrets.EXAMPLE_ORG_USERNAME }}",
"password": "${{ secrets.EXAMPLE_ORG_PASSWORD }}"
}
}
} Inline PHP ScriptsIf you have to run multiple lines of PHP code in your workflow, you can do that easily without saving it to a file. Put the code in the run property of a step and specify the shell as php {0} . - name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
- name: Run PHP code
shell: php {0}
run: |
<?php
$welcome = "Hello, world";
echo $welcome; Problem MatchersProblem matchers are json configurations which identify errors and warnings in your logs and surface them prominently in the GitHub Actions UI by highlighting them and creating code annotations. PHPSetup 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" PHPUnitSetup 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 it does not require problem matchers. - name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
tools: phpstan
- name: Run PHPStan
run: phpstan analyse src PsalmPsalm supports error reporting in GitHub Actions with an output format github . - name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
tools: psalm
- name: Run Psalm
run: psalm --output-format=github Tools with checkstyle supportFor 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: '8.1'
tools: cs2pr, phpcs
- name: Run phpcs
run: phpcs -q --report=checkstyle src | cs2pr ExamplesExamples 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
| Laminas MVC
| macOS , ubuntu and windows
| laminas-mvc.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
|
🔖 Versioning- Use the
v2 tag as setup-php version. It is a rolling tag and is synced with the latest minor and patch releases. With v2 you automatically get the bug fixes, security patches, new features and support for latest PHP 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, security patches or new features.
- For
debugging any issues
verbose tag can be used temporarily. It outputs all the logs and is also synced with the latest releases. - It is highly discouraged to use the
master branch as version, 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, you should
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 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.
👍 ContributionsContributions are welcome!
- See Contributor's Guide before you start.
- If you face any issues or want to suggest a feature/improvement, start a discussion here.
Contributors of setup-php and other related
projects 💖 Support This Project- Please star the project and share it. If you blog, please share your experience of using
setup-php . - Please reach out if you have any questions about sponsoring setup-php.
Many users and organisations support setup-php via
GitHub Sponsors. These companies generously provide
setup-php their products and services to aid in the development of this project.
📦 Dependencies- Node.js dependencies
- aaronparker/VcRedist
- 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
|