mirror of https://github.com/shivammathur/setup-php.git synced 2024-11-22 20:01:06 +07:00

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

code-coverage composer continuous-integration github-actions php php-extensions static-analysis tools

Go to file

Shivam Mathur 7e81c058fb Merge pull request #54 from shivammathur/develop Add option to disable coverage drivers		2019-10-05 15:32:11 +05:30
__tests__	Add option to disable coverage drivers	2019-10-05 15:00:00 +05:30
.github	Fix scripts and action workflow	2019-09-25 17:04:10 +05:30
examples	Fix examples and add coverage badge	2019-10-05 06:44:08 +05:30
lib	Add option to disable coverage drivers	2019-10-05 15:00:00 +05:30
node_modules	Add coverage support, improve logs and fix bugs	2019-09-26 20:24:24 +05:30
src	Add option to disable coverage drivers	2019-10-05 15:00:00 +05:30
.gitignore	Improve code quality and write tests	2019-09-20 21:54:46 +05:30
.prettierrc.json	init	2019-09-06 05:17:43 +05:30
action.yml	Add option to disable coverage drivers	2019-10-05 15:00:00 +05:30
jest.config.js	Improve code quality and write tests	2019-09-20 21:54:46 +05:30
LICENSE	Add README and LICENSE	2019-09-06 05:51:19 +05:30
package-lock.json	Add option to disable coverage drivers	2019-10-05 15:00:00 +05:30
package.json	Add option to disable coverage drivers	2019-10-05 15:00:00 +05:30
README.md	Add option to disable coverage drivers	2019-10-05 15:00:00 +05:30
tsconfig.json	init	2019-09-06 05:17:43 +05:30

README.md

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 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	`Beta`/`RC`	`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 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.

Note: Make sure you add steps to run your tests after the setup steps given in these examples.

📜 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.