Popularity
3.5
Growing
Activity
8.6
Growing
246
8
11

Description

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 to see how to use this.

Programming language: TypeScript
License: MIT License
Latest version: v1.5.1

Setup PHP in GitHub Actions alternatives and similar libraries

Based on the "Build Tools" category

Do you think we are missing an alternative of Setup PHP in GitHub Actions or a related project?

Add another 'Build Tools' Library

README

Setup PHP in GitHub Actions


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.

Contents

:tada: 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 RC4/RC6 Active

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

:cloud: OS/Platform Support

Virtual environment matrix.operating-system
Windows Server 2019 windows-latest or windows-2019
Ubuntu 18.04 ubuntu-latest or ubuntu-18.04
Ubuntu 16.04 ubuntu-16.04
macOS X Catalina 10.15 macOS-latest or macOS-10.15

:wrench: PHP Extension Support

  • On ubuntu extensions which have the package in APT are installed. If extension is not in APT, you can use PECL to install the extension as fallback by specifying pecl: true.
  • On windows extensions which have windows binary on PECL can be installed.
  • On macOS extensions which are on PECL can be 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.

:signal_strength: 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.
It is much faster than Xdebug.
PCOV needs PHP >= 7.1.
If your source code directory is other than src, lib or, app, specify pcov.directory using the ini-values-csv input.

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. Consider disabling the coverage using this PHP action 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 phpdbg for running your tests.
uses: shivammathur/setup-php@master
with:
  php-version: '7.3'
  coverage: none

:memo: Usage

Inputs supported by this GitHub Action.

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

See [action.yml](action.yml "Metadata for this GitHub Action") and usage below for more info.

Basic Usage

steps:
- name: Checkout
  uses: actions/checkout@master
- name: Setup PHP
  uses: shivammathur/setup-php@master
  with:
    php-version: '7.3'
    extension-csv: mbstring, xdebug #optional, setup extensions
    ini-values-csv: post_max_size=256M, short_open_tag=On #optional, setup php.ini configuration
    coverage: xdebug #optional, setup coverage driver
    pecl: true #optional, setup PECL
- 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: Setup PHP
      uses: shivammathur/setup-php@master
      with:
        php-version: ${{ matrix.php-versions }}
        extension-csv: mbstring, xdebug #optional, setup extensions
        ini-values-csv: post_max_size=256M, short_open_tag=On #optional, setup php.ini configuration
        coverage: xdebug #optional, setup coverage driver
        pecl: true #optional, setup PECL
    - name: Check PHP Version
      run: php -v
    - name: Check Composer Version
      run: composer -V
    - name: Check PHP Extensions
      run: php -m

Cache dependencies

You can persist composer's internal cache directory using the action/cache GitHub Action. 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.

Note: Please do not cache vendor directory using action/cache as that will have side-effects.

- 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@v1
  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

Examples

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

Framework/Package Runs on Workflow
CodeIgniter macOS, ubuntu and windows [codeigniter.yml](./examples/codeigniter.yml "GitHub Action for CodeIgniter")
Laravel with MySQL and Redis ubuntu [laravel-mysql.yml](./examples/laravel-mysql.yml "GitHub Action for Laravel with MySQL and Redis")
Laravel with PostgreSQL and Redis ubuntu [laravel-postgres.yml](./examples/laravel-postgres.yml "GitHub Action for Laravel with PostgreSQL and Redis")
Laravel without services macOS, ubuntu and windows [laravel.yml](./examples/laravel.yml "GitHub Action for Laravel without services")
Lumen with MySQL and Redis ubuntu [lumen-mysql.yml](./examples/lumen-mysql.yml "GitHub Action for Lumen with MySQL and Redis")
Lumen with PostgreSQL and Redis ubuntu [lumen-postgres.yml](./examples/lumen-postgres.yml "GitHub Action for Lumen with PostgreSQL and Redis")
Lumen without services macOS, ubuntu and windows [lumen.yml](./examples/lumen.yml "GitHub Action for Lumen without services")
Phalcon with MySQL ubuntu [phalcon-mysql.yml](./examples/phalcon-mysql.yml "GitHub Action for Phalcon with MySQL")
Phalcon with PostgreSQL ubuntu [phalcon-postgres.yml](./examples/phalcon-postgres.yml "GitHub Action for Phalcon with PostgreSQL")
Slim Framework macOS, ubuntu and windows [slim-framework.yml](./examples/slim-framework.yml "GitHub Action for Slim Framework")
Symfony with MySQL ubuntu [symfony-mysql.yml](./examples/symfony-mysql.yml "GitHub Action for Symfony with MySQL")
Symfony with PostgreSQL ubuntu [symfony-postgres.yml](./examples/symfony-postgres.yml "GitHub Action for Symfony with PostgreSQL")
Yii2 Starter Kit with MySQL ubuntu [yii2-mysql.yml](./examples/yii2-mysql.yml "GitHub Action for Yii2 Starter Kit with MySQL")
Yii2 Starter Kit with PostgreSQL ubuntu [yii2-postgres.yml](./examples/yii2-postgres.yml "GitHub Action for Yii2 Starter Kit with PostgreSQL")
Zend Framework macOS, ubuntu and windows [zend-framework.yml](./examples/zend-framework.yml "GitHub Action for Zend Framework")

:scroll: License

The scripts and documentation in this project are released under the [MIT License](LICENSE "License for shivammathur/setup-php"). This project has multiple dependencies and their licenses can be found in their respective repositories.

:+1: Contributions

Contributions are welcome! See [Contributor's Guide](.github/CONTRIBUTING.md "shivammathur/setup-php contribution guide"). If you face any issues while using this or want to suggest a feature/improvement, create an issue here.

:sparkling_heart: Support this project

If this action helped you.

  • Please star the project and share it, this helps reach more people.
  • If you blog, write about your experience using this.
  • Support on this project on or using .

:bookmark: This action uses the following works

:bookmark_tabs: Further Reading


*Note that all licence references and agreements mentioned in the Setup PHP in GitHub Actions README section above are relevant to that project's source code only.