Skip to content

GitHub action to set up PHP with extensions, php.ini configuration, coverage drivers, and various tools.

License

Notifications You must be signed in to change notification settings

joelwurtz/setup-php

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

69 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Setup PHP in GitHub Actions

Setup PHP in GitHub Actions

GitHub Actions status Codecov Code Coverage LICENSE PHP Versions Supported Support me on Patreon Support me on PayPal Contact me on Codementor

Setup PHP with required extensions, php.ini configuration and composer in GitHub Actions. This action can be added as a step in your action workflow and it will setup the PHP environment you need to test your application. Refer to Usage section and examples to see how to use this.

πŸŽ‰ PHP Support

PHP Version Stability Release Support
5.6 Stable End of life
7.0 Stable End of life
7.1 Stable Security fixes only
7.2 Stable Active
7.3 Stable Active
7.4 RC3 Active

Note: PHP 7.4 is currently in development, do not use in production/release branches.

☁️ OS/Platform Support

Virtual environment matrix.operating-system
Windows Server 2019 windows-latest or windows-2019
Windows Server 2016 R2 windows-2016
Ubuntu 18.04 ubuntu-latest or ubuntu-18.04
Ubuntu 16.04 ubuntu-16.04
macOS X Mojave 10.14 macOS-latest or macOS-10.14

πŸ”§ PHP Extension Support

  • On ubuntu extensions which have the package in apt are installed.
  • On windows and macOS PECL extensions are installed.
  • Extensions which are installed along with PHP if specified are enabled.
  • Extensions which cannot be installed 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

uses: shivammathur/setup-php@master
with:
  php-version: '7.3'  
  coverage: xdebug

PCOV

Specify coverage: pcov to use PCOV. PCOV is way faster than Xdebug. For pcov.directory to be other than src, lib or, app, specify it using the ini-values-csv input. PCOV needs PHPUnit >= 8.0 and PHP >= 7.1, PHPUnit needs PHP >= 7.2. So use PHP >= 7.2 with PCOV

uses: shivammathur/setup-php@master
with:
  php-version: '7.3'
  ini-values-csv: pcov.directory=api #optional, see above for usage.
  coverage: pcov

Disable coverage

Specify coverage: none to disable both Xdebug and PCOV.

uses: shivammathur/setup-php@master
with:
  php-version: '7.3'
  coverage: none

πŸ“ Usage

Inputs supported by this GitHub Action.

  • php-version required
  • extension-csv optional
  • ini-values-csv optional
  • coverage optional

See action.yml and usage below for more info.

Basic Usage

steps:
- name: Checkout
  uses: actions/checkout@master
- name: Installing PHP
  uses: shivammathur/setup-php@master
  with:
    php-version: '7.3'
    extension-csv: mbstring, xdebug #optional
    ini-values-csv: post_max_size=256M, short_open_tag=On #optional
    coverage: xdebug #optional
- name: Check PHP Version
  run: php -v
- name: Check Composer Version
  run: composer -V
- name: Check PHP Extensions
  run: php -m

Matrix Testing

jobs:
  run:    
    runs-on: ${{ matrix.operating-system }}
    strategy:
      max-parallel: 15
      matrix:
        operating-system: [ubuntu-latest, windows-latest, macOS-latest]
        php-versions: ['5.6', '7.0', '7.1', '7.2', '7.3']
    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
    steps:
    - name: Checkout
      uses: actions/checkout@master
    - name: Install PHP
      uses: shivammathur/setup-php@master
      with:
        php-version: ${{ matrix.php-versions }}
        extension-csv: mbstring, xdebug #optional
        ini-values-csv: post_max_size=256M, short_open_tag=On #optional
        coverage: xdebug #optional
    - name: Check PHP Version
      run: php -v
    - name: Check Composer Version
      run: composer -V
    - name: Check PHP Extensions
      run: php -m           

Examples

Examples for setting up this GitHub Action with different PHP Frameworks/Packages.

Framework/Package Workflow
CodeIgniter codeigniter.yml
Laravel MySQL Redis laravel-mysql.yml
Laravel PostgreSQL Redis laravel-postgres.yml
Laravel laravel.yml
Slim Framework slim-framework.yml
Symfony MySQL symfony-mysql.yml
Symfony PostgreSQL symfony-postgres.yml
Yii2 Starter Kit MySQL yii2-mysql.yml
Yii2 Starter Kit PostgreSQL yii2-postgres.yml
Zend Framework zend-framework.yml

πŸ“œ License

The scripts and documentation in this project are released under the MIT License. This project has multiple dependencies and their licenses can be found in their respective repositories.

πŸ‘ Contributions

Contributions are welcome! See Contributor's Guide.

πŸ’– Support this project

  • Please star the project and share it among your developer friends.
  • Consider supporting on Support me on Patreon and Support me on Paypal.

πŸ”– This action uses the following works

πŸ“‘ Further Reading

About

GitHub action to set up PHP with extensions, php.ini configuration, coverage drivers, and various tools.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 42.9%
  • Shell 34.6%
  • PowerShell 20.8%
  • PHP 1.6%
  • JavaScript 0.1%