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
- 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
- Composer GitHub OAuth
- Inline PHP Scripts
- 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 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 |
| Windows Server 2022 | windows-2022 |
PHP 8.0 |
| macOS Catalina 10.15 | macos-latest or macos-10.15 |
PHP 8.0 |
| macOS Big Sur 11.x | macos-11 |
PHP 8.0 |
Self-Hosted Runners
| Host OS/Virtual environment | YAML workflow label |
|---|---|
| Ubuntu 18.04 | self-hosted or Linux |
| Ubuntu 20.04 | self-hosted or Linux |
| Ubuntu 21.04 | self-hosted or Linux |
| Debian 9 | self-hosted or Linux |
| Debian 10 | self-hosted or Linux |
| Debian 11 | 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.
- Operating systems based on the above Ubuntu and Debian versions are also supported on a best effort basis.
- 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.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 |
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 |
8.2 |
Nightly |
In development |
GitHub-hosted, self-hosted |
Notes:
- Specifying
8.1and8.2inphp-versioninput installs a nightly build ofPHP 8.1.0-devandPHP 8.2.0-devrespectively. See nightly build setup for more information. - To use JIT on
PHP 8.0and above, refer to the JIT configuration section.
➕
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 onPECLor a git repository can be set up.
- name: Setup PHP with PECL extension
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
extensions: imagick, swoole
-
On
Windows, extensions available onPECLwhich have theDLLbinary can be set up. -
On
macOS, extensions available onPECLor a git repository can be set up. -
On
UbuntuandmacOSto 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
PECLcan 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
- Pre-release versions extensions available on
PECLcan be set up 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: '8.0'
extensions: xdebug-beta
- 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.0'
extensions: :opcache
- All shared extensions can be disabled by specifying
none. Whennoneis 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. So, make sure you add the required extensions after none in the extensions input.
- name: Setup PHP without any shared extensions except mbstring
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
extensions: none, mbstring
- Extension
intlcan be set up with specificICUversion forPHP 5.6and above inUbuntuworkflows 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: '8.0'
extensions: intl-69.1
-
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_firebird,pdo_oci,pecl_http,phalcon3andphalcon4on all supported OS.
-
By default, extensions which cannot be added or disabled 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: '8.0'
extensions: oci8
env:
fail-fast: true
🔧
Tools Support
These tools can be set up 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, 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, 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: '8.0'
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/packagematching the listing on Packagist. This format accepts the same version constraints ascomposer.
- name: Setup PHP with tools
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
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.3ortool:1.2.3-beta1. - Major version. For example
tool:1ortool:1.x. - Major and minor version. For example
tool:1.2ortool:1.2.x.
When you specify just the major version or the version in
major.minorformat, the latest patch version matching the input will be setup.Except for major versions of
composer, For other tools when you specify only themajorversion or the version inmajor.minorformat for any tool you can get rate limited by GitHub's API. To avoid this, it is recommended to provide aGitHubOAuth token. You can do that by settingCOMPOSER_TOKENenvironment variable. - Semver. For example
- name: Setup PHP with tools
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
tools: php-cs-fixer:3, phpunit:8.5
env:
COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- The latest stable version of
composeris set up by default. You can set up the requiredcomposerversion by specifying the major versionv1orv2, or the version inmajor.minororsemverformat, Additionally for composersnapshotandpreviewcan also be specified to set up the respective releases.
- name: Setup PHP with composer v2
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
tools: composer:v2
- If you do not use composer in your workflow, you can specify
tools: noneto skip it.
- name: Setup PHP without composer
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
tools: none
-
Scripts
phpizeandphp-configare set up with the same version as of the input PHP version. -
The latest version of
blackfirecli is set up whenblackfireis specified in tools input. Please refer to the official documentation for usingblackfirewith GitHub Actions. -
Tools
prestissimoandcomposer-prefetcherwill be skipped unlesscomposer:v1is also specified in tools input. It is recommended to dropprestissimoand usecomposer v2. -
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: '8.0'
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 set up it withtoolsinput as the two instances of the tool might conflict.
📶
Coverage Support
Xdebug
Specify 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.0'
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.
- 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: '8.0'
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 disable both Xdebug and PCOV.
Disable coverage for these reasons:
- You are not generating coverage reports while testing.
- It will disable
Xdebug, which will have a positive impact on PHP performance. - You are using
phpdbgfor 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.0'
coverage: none
📝
Usage
Inputs
Specify using
withkeyword
php-version (required)
- Specify the PHP version you want to set up.
- Accepts a
string. For example'8.0'. - Accepts
latestto set up the latest stable PHP version. - Accepts
nightlyto set up a nightly build from the master branch of PHP. - 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 disable.
- Accepts a
stringin csv-format. For examplembstring, :opcache. - Accepts
noneto disable all shared extensions. - Shared extensions prefixed with
:are disabled. - 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.
Outputs
php-version
To use outputs, give 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.0'
- name: Print PHP version
run: echo ${{ steps.setup-php.outputs.php-version }}
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: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
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', '8.0']
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 Setup
Setup a nightly build of
PHP 8.1orPHP 8.2.
- This version is currently in development.
- Some user space extensions might not support this version currently.
steps:
- 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 set up by default.- On
UbuntuandmacOSonlyNTSversions are supported. - On
WindowsbothTSandNTSversions 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.0'
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: '8.0'
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: '8.0'
Multi-Arch Setup
Setup PHP on multiple architecture on Ubuntu GitHub Runners.
PHP 5.6toPHP 8.0are supported bysetup-phpon multiple architecture onUbuntu.- For this, you can use
shivammathur/nodeimages as containers. These have compatibleNodejsinstalled for JavaScript based GitHub Actions. - 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
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
Self Hosted Setup
Setup 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.
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: 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
steps:
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
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:20.04.
# 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:2004
# For runs-on: ubuntu-18.04
act -P ubuntu-18.04=shivammathur/node:1804
JIT Configuration
Enable Just-in-time(JIT) on PHP 8.0 and above.
- To enable JIT, enable
opcachein cli mode by settingopcache.enable_cli=1. - JIT conflicts with
Xdebug,PCOV, and other extensions which overridezend_execute_exfunction, so setcoverage: noneand disable any such extension if added. - 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'
coverage: none
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 }}-
Composer GitHub OAuth
If 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 COMPOSER_TOKEN environment variable. You can use GITHUB_TOKEN secret for this purpose.
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.0'
env:
COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Inline PHP Scripts
If 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.0'
- name: Run PHP code
shell: php {0}
run: |
$welcome = "Hello, world";
echo $welcome;
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: '8.0'
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: '8.0'
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: '8.0'
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, security patches, 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, security patches 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.
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 this action.
- Please sponsor setup-php using GitHub sponsors.
- Please reach out if you have any questions about sponsoring setup-php.
Corporate Sponsors
Individual Sponsors
📦
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)
11.1k Jan 2, 2023
104 Jan 1, 2023
8 Oct 10, 2022
11 Aug 19, 2022
29 Nov 27, 2022
1 Jan 10, 2022
13 Nov 18, 2022
433 Dec 6, 2022
4 Feb 5, 2022
13 Dec 2, 2022
2 Nov 9, 2022
1 May 11, 2022
997 Dec 22, 2022
2 Oct 9, 2022
2.2k Dec 29, 2022
98 Nov 27, 2022
2 Oct 29, 2021
1 Dec 13, 2021
31 Dec 22, 2022