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
- PHP Support
- PHP Extension Support
- Tools Support
- Coverage Support
- Usage
- Inputs
- 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
- Cache Node.js Dependencies
- Composer GitHub OAuth
- Problem Matchers
- Examples
- Versioning
- License
- Contributions
- Support This Project
- Dependencies
- Further Reading
☁️
OS/Platform Support
Both GitHub-hosted and self-hosted runners are suppported by setup-php on the following OS/Platforms.
GitHub-Hosted Runners
| Virtual environment | YAML workflow label | Pre-installed PHP |
|---|---|---|
| Ubuntu 16.04 | ubuntu-16.04 |
PHP 5.6 to PHP 8.0 |
| Ubuntu 18.04 | ubuntu-18.04 |
PHP 7.1 to PHP 8.0 |
| Ubuntu 20.04 | ubuntu-latest or ubuntu-20.04 |
PHP 7.4 to PHP 8.0 |
| Windows Server 2019 | windows-latest or windows-2019 |
PHP 8.0 |
| macOS Catalina 10.15 | macos-latest or macos-10.15 |
PHP 8.0 |
| macOS Big Sur 11.0 | macos-11.0 |
PHP 8.0 |
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 |
| macOS Big Sur 11.x x86_64/arm64 | self-hosted or macOS |
- Refer to the self-hosted setup to use the action on self-hosted runners.
- If the requested PHP version is pre-installed,
setup-phpswitches to it, otherwise it installs the PHP version.
🎉
PHP Support
On all supported OS/Platforms the following PHP versions are supported as per the runner.
- PHP 5.3 to PHP 8.1 on GitHub-hosted runners.
- PHP 5.6 to PHP 8.1 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 |
Security fixes only |
GitHub-hosted, self-hosted |
7.4 |
Stable |
Active |
GitHub-hosted, self-hosted |
8.0 |
Stable |
Active |
GitHub-hosted, self-hosted |
8.1 |
Nightly |
In development |
GitHub-hosted, self-hosted |
Notes:
- Specifying
8.1inphp-versioninput installs a nightly build ofPHP 8.1.0-dev. See nightly build setup for more information. - To use JIT on
PHP 8.0andPHP 8.1refer to the JIT configuration section.
➕
PHP Extension Support
PHP extensions can be setup using the extensions input. It accepts a string in csv-format.
- On
Ubuntu, extensions which are available as a package, available onPECL, or hosted on GitHub can be setup.
- name: Setup PHP with PECL extension
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
extensions: imagick, swoole
-
On
Windows, extensions available onPECLwhich have theDLLbinary can be setup. -
On
macOS, extensions available onPECLor hosted on GitHub can be installed. -
Extensions installed along with PHP if specified are enabled.
-
Specific versions of extensions available on
PECLcan be setup 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
- Pre-release versions extensions available on
PECLcan be setup by suffixing the extension's name with its state i.ealpha,beta,develorsnapshot.
- name: Setup PHP with pre-release PECL extension
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
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
intlcan be setup with specificICUversion forPHP 5.6toPHP 8.0inUbuntuworkflows by suffixingintlwith theICUversion.ICU 50.2and newer versions are supported. Refer toICU buildsfor the specific versions supported.
- name: Setup PHP with intl
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
extensions: intl-68.2
-
Extensions loaded by default after
setup-phpruns can be found on the wiki. -
These extensions have custom support:
cubrid,pdo_cubridandgearmanonUbuntu.geosonUbuntuandmacOS.blackfire,couchbase,ioncube,oci8,pdo_oci,pecl_http,phalcon3andphalcon4on all supported OS.
-
By default, extensions which cannot be added or removed gracefully leave an error message in the logs, the action is not interrupted. To change this behaviour you can set
fail-fastflag totrue.
- name: Setup PHP with fail-fast
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
extensions: oci8
env:
fail-fast: true
- Extensions can be compiled from source if they are hosted on GitHub. In this case, the version specification contains the repository and branch/tag to clone:
- name: Setup PHP and remove shared extension
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
extensions: mongodb-mongodb/[email protected]
The version can be a branch name or tag as supported by git clone -b <name>. The clone is performed recursively, i.e. submodules will be cloned as well.
🔧
Tools Support
These tools can be setup globally using the tools input. It accepts a string in csv-format.
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, php-config, php-cs-fixer, phpcbf, phpcpd, phpcs, phpize, phplint, phpmd, phpspec, phpstan, phpunit, prestissimo, protoc, psalm, 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: '7.4'
tools: php-cs-fixer, phpunit
- To set up a particular version of a tool, specify it in the form
tool:version. The latest stable version ofcomposeris set up by default. You can set up the requiredcomposerversion by specifyingv1,v2,snapshotorpreviewas versions, or the exact version in semver format.
- name: Setup PHP with composer v2
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
tools: composer:v2
-
Tools
prestissimoandcomposer-prefetcherwill be skipped unlesscomposer:v1is also specified in tools input. It is recommended to dropprestissimoand usecomposer v2. -
The latest versions of both agent
blackfire-agentand clientblackfireare setup whenblackfireis specified in tools input. Please refer to the official documentation for usingblackfirewith GitHub Actions. -
Version for other tools should be in
semverformat and a valid release of the tool. This is useful for installing tools for older versions of PHP. For example to set upPHPUnitonPHP 7.2.
- name: Setup PHP with tools
uses: shivammathur/setup-php@v2
with:
php-version: '7.2'
tools: phpunit:8.5.8
- By default, tools which cannot be set up gracefully leave an error message in the logs, the action is not interrupted. To change this behaviour you can set
fail-fastflag totrue.
- name: Setup PHP with fail-fast
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
tools: deployer
env:
fail-fast: true
Notes
- Input
toolsis useful to set up tools which you only use in GitHub Actions, thus keeping yourcomposer.jsontidy. - If you do not want to use all your dev-dependencies in GitHub Actions workflow, you can run composer with
--no-devand install required tools usingtoolsinput to speed up your workflow. - If you have a tool in your
composer.json, do not setup it withtoolsinput as the two instances of the tool might conflict.
📶
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
- 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
PCOV
Specify coverage: pcov to use PCOV and disable Xdebug.
Runs on PHP 7.1 and newer PHP versions.
- In most cases, tests with
PCOVexecute much faster than withXdebug. - If your source code directory is other than
src,libor,app, specifypcov.directoryusing theini-valuesinput.
- 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.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/clobberbefore executing your tests.
- name: Setup PCOV
run: |
composer require pcov/clobber
vendor/bin/pcov clobber
Disable Coverage
Specify coverage: none to remove both Xdebug and PCOV.
Disable coverage 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
phpdbgfor 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
Specify using
withkeyword
php-version (required)
- Specify the PHP version you want to set up.
- Accepts a
string. For example'7.4'. - Accepts
latestto set up the latest stable PHP version. - Accepts the format
d.x, wheredis the major version. For example5.x,7.xand8.x. - See PHP support for supported PHP versions.
extensions (optional)
- Specify the extensions you want to add or remove.
- Accepts a
stringin csv-format. For examplembstring, :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
stringin csv-format. For examplepost_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,pcovornone. - See coverage support for more info.
tools (optional)
- Specify the tools you want to set up.
- Accepts a
stringin csv-format. For example:phpunit, phpcs - See tools Support for tools supported.
Flags
Specify using
envkeyword
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
trueandfalse.
phpts (optional)
- Specify to set up thread-safe version of PHP on Windows.
- Accepts
tsandnts. - 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
trueandfalse. - By default, it is set to
false. - See force update setup for more info.
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, max_execution_time=180
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: ['7.3', '7.4']
phpunit-versions: ['latest']
include:
- operating-system: 'ubuntu-latest'
php-versions: '7.2'
phpunit-versions: '8.5.13'
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, max_execution_time=180
coverage: xdebug
tools: php-cs-fixer, phpunit:${{ matrix.phpunit-versions }}
Nightly Build Setup
Setup a nightly build of
PHP 8.1.
- This version is currently in development.
- Some user space extensions might not support this version currently.
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup nightly PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
extensions: mbstring
ini-values: post_max_size=256M, max_execution_time=180
coverage: xdebug
tools: php-cs-fixer, phpunit
Thread Safe Setup
Setup
TSorNTSPHP onWindows.
NTSversions are setup by default.- On
UbuntuandmacOSonlyNTSversions are supported. - On
WindowsbothTSandNTSversions 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 Setup
Update to the latest patch of PHP versions.
- Pre-installed PHP versions on the GitHub Actions images are not updated to their latest patch release by default.
- You can specify the
updateenvironment variable totruefor updating 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'
Multi-Arch Setup
Setup PHP on multiple architecture on Ubuntu GitHub Runners.
PHP 5.6toPHP 7.4are supported bysetup-phpon multiple architecture onUbuntu.- For this, you can use
shivammathur/nodeimages as containers. These have compatibleNodejsandspcutility. - Using
spcyou can runsetup-phpon bothi386andamd64containers as opposed to default syntax, which only supportsamd64. - Currently, for
Armbased 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
run: |
# Update spc (See https://github.com/shivammathur/spc for options)
spc -U
# Install PHP
spc --php-version "7.4" \
--extensions "mbstring, intl" \
--ini-values "post_max_size=256M, max_execution_time=180" \
--coverage "xdebug" \
--tools "php-cs-fixer, phpunit"
Self Hosted Setup
Setup PHP on a self-hosted runner.
- To set up a dockerized self-hosted runner, refer to this guide to set up in an
Ubuntucontainer and refer to this guide to set up in aWindowscontainer. - 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 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 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-hostedrunners which are used byGitHub-hostedrunners.
Local Testing Setup
Test your
Ubuntuworkflow locally usingnektos/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 images.
Choose the image tag which matches the runs-on property in your workflow:
# 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
JIT Configuration
Enable Just-in-time(JIT) on PHP 8.0 and PHP 8.1.
- To enable JIT, enable
opcachein cli mode by settingopcache.enable_cli=1. - By default,
opcache.jit=1235andopcache.jit_buffer_size=256Mare set which can be changed usingini-valuesinput. - 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.0'
ini-values: opcache.enable_cli=1, opcache.jit=tracing, opcache.jit_buffer_size=64M
Cache Extensions
You 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 Dependencies
If 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
vendordirectory usingaction/cacheas that will have side effects. - If you do not commit
composer.lock, you can use the hash ofcomposer.jsonas the key for your cache.
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
- If you support a range of
composerdependencies and useprefer-lowestandprefer-stableoptions, you can store them in your matrix and add them to the keys.
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}-${{ matrix.prefer }}-
restore-keys: ${{ runner.os }}-composer-${{ matrix.prefer }}-
Cache Node.js Dependencies
If your project has node.js dependencies, you can persist NPM or yarn cache directory. The cached files are available across check-runs and will reduce the workflow execution time.
- name: Get node.js cache directory
id: node-cache-dir
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.node-cache-dir.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 them 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 it does not require problem matchers.
- 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
- Use the
v2tag assetup-phpversion. It is a rolling tag and is synced with the latest minor and patch releases. Withv2you automatically get the bug fixes, new features and support for latest PHP releases. For debugging any issuesverbosetag 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.
- It is highly discouraged to use the
masterbranch as version, it might break your workflow after major releases as they have breaking changes. - If you are using the
v1tag or a1.x.yversion, you should switch to v2 asv1only gets critical bug fixes. Maintenance support forv1will be dropped with the lastPHP 8.0release.
📜
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-phpis 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 or want to suggest a feature/improvement, start a discussion here.
Join the list of setup-php contributors
💖
Support This Project
- If setup-php saved your developer time, please consider sponsoring setup-php:
- Please reach out if you have any questions regarding sponsoring setup-php.
- Please star the project and share it. If you blog, please share your experience of using this action.
Huge thanks to the following companies for supporting setup-php
📦
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
![[NFR] Use Phalcon binary package/dll](https://avatars.githubusercontent.com/u/7444246?v=4)
14 Dec 22, 2022
17 Jun 16, 2022
8 Jul 26, 2022
55 Dec 7, 2022
105 Mar 4, 2022
1.2k Nov 9, 2022
6 Oct 25, 2022
1.1k Dec 22, 2022
263 Sep 28, 2022
52 Dec 17, 2022
28 Dec 1, 2021
2.4k Jan 6, 2023
13 Oct 31, 2022
435 Jan 5, 2023
946 Jan 1, 2023
3k Jan 5, 2023
8.5k Jan 5, 2023
15 Aug 9, 2022
86 Dec 21, 2022