From c1c0acc338cf4ba113f263ae117d22e5e590ad5d Mon Sep 17 00:00:00 2001 From: Shivam Mathur Date: Thu, 10 Oct 2019 17:47:17 +0530 Subject: [PATCH] Fix scripts, README and examples --- .github/workflows/workflow.yml | 13 +++--- README.md | 74 ++++++++++++++++++---------------- examples/codeigniter.yml | 8 ++-- examples/laravel-mysql.yml | 1 + examples/laravel-postgres.yml | 1 + examples/laravel.yml | 10 ++--- examples/slim-framework.yml | 8 ++-- examples/symfony-mysql.yml | 3 +- examples/symfony-postgres.yml | 3 +- examples/symfony.yml | 5 ++- examples/yii2-mysql.yml | 5 ++- examples/yii2-postgres.yml | 5 ++- examples/zend-framework.yml | 8 ++-- package-lock.json | 2 +- package.json | 2 +- src/scripts/darwin.sh | 6 ++- src/scripts/linux.sh | 11 +++-- 17 files changed, 87 insertions(+), 78 deletions(-) diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml index 39cc0d26f..ecbd22d5a 100644 --- a/.github/workflows/workflow.yml +++ b/.github/workflows/workflow.yml @@ -1,24 +1,27 @@ name: Main workflow -on: [push] +on: [push, pull_request] jobs: run: name: Run runs-on: ${{ matrix.operating-system }} strategy: - max-parallel: 8 + fail-fast: false + max-parallel: 15 matrix: operating-system: [ubuntu-latest, windows-latest, macOS-latest] php-versions: ['5.6', '7.0', '7.1', '7.2', '7.3'] steps: - name: Checkout uses: actions/checkout@master + with: + fetch-depth: 1 - - name: Set Node.js 10.x + - name: Setup Node.js 10.x uses: actions/setup-node@master with: - version: 10.x + node-version: 10.x - - name: Installing NPM + - name: Installing NPM packages run: npm install - name: Run tests and send coverage diff --git a/README.md b/README.md index ee1354c1b..ee1bbdb25 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,15 @@ # 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 + 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](https://github.com/features/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](#memo-usage) section and [examples](#examples) to see how to use this. +Setup PHP with required extensions, php.ini configuration and composer in [GitHub Actions](https://github.com/features/actions "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](#memo-usage "How to use this") section and [examples](#examples "Examples of use") to see how to use this. ## :tada: PHP Support @@ -50,8 +50,8 @@ Setup PHP with required extensions, php.ini configuration and composer in [GitHu ### Xdebug -Specify `coverage: xdebug` to use `Xdebug`. -Runs on all [PHP versions supported](#tada-php-support) +Specify `coverage: xdebug` to use `Xdebug`. +Runs on all [PHP versions supported](#tada-php-support "List of PHP versions supported on this GitHub Action") ```yaml uses: shivammathur/setup-php@master @@ -62,8 +62,9 @@ with: ### 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. +Specify `coverage: pcov` to use `PCOV`. +It is much faster than `Xdebug`. +If your source code directory is other than `src`, `lib` or, `app`, specify `pcov.directory` 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` ```yaml @@ -75,7 +76,12 @@ with: ``` ### 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`. ```yaml uses: shivammathur/setup-php@master @@ -93,7 +99,7 @@ Inputs supported by this GitHub Action. - ini-values-csv `optional` - coverage `optional` -See [action.yml](action.yml) and usage below for more info. +See [action.yml](action.yml "Metadata for this GitHub Action") and usage below for more info. ### Basic Usage @@ -151,26 +157,26 @@ jobs: Examples for setting up this GitHub Action with different PHP Frameworks/Packages. -|Framework/Package|Workflow| -|--- |--- | -|CodeIgniter|[codeigniter.yml](./examples/codeigniter.yml)| -|Laravel `MySQL` `Redis`|[laravel-mysql.yml](./examples/laravel-mysql.yml)| -|Laravel `PostgreSQL` `Redis`|[laravel-postgres.yml](./examples/laravel-postgres.yml)| -|Laravel|[laravel.yml](./examples/laravel.yml)| -|Slim Framework|[slim-framework.yml](./examples/slim-framework.yml)| -|Symfony `MySQL`|[symfony-mysql.yml](./examples/symfony-mysql.yml)| -|Symfony `PostgreSQL`|[symfony-postgres.yml](./examples/symfony-postgres.yml)| -|Yii2 Starter Kit `MySQL`|[yii2-mysql.yml](./examples/yii2-mysql.yml)| -|Yii2 Starter Kit `PostgreSQL`|[yii2-postgres.yml](./examples/yii2-postgres.yml)| -|Zend Framework|[zend-framework.yml](./examples/zend-framework.yml)| +|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")| +|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). This project has multiple [dependencies](https://github.com/shivammathur/setup-php/network/dependencies) and their licenses can be found in their respective repositories. +The scripts and documentation in this project are released under the [MIT License](LICENSE "License for shivammathur/setup-php"). This project has multiple [dependencies](https://github.com/shivammathur/setup-php/network/dependencies "Dependencies for this PHP Action") and their licenses can be found in their respective repositories. ## :+1: Contributions -Contributions are welcome! See [Contributor's Guide](.github/CONTRIBUTING.md). +Contributions are welcome! See [Contributor's Guide](.github/CONTRIBUTING.md "shivammathur/setup-php contribution guide"). ## :sparkling_heart: Support this project @@ -179,14 +185,14 @@ Contributions are welcome! See [Contributor's Guide](.github/CONTRIBUTING.md). ## :bookmark: This action uses the following works -- [powershell-phpmanager](https://github.com/mlocati/powershell-phpmanager) -- [Homebrew](https://brew.sh/) -- [ppa:ondrej/php](https://launchpad.net/~ondrej/+archive/ubuntu/php) -- [exolnet/homebrew-deprecated](https://github.com/eXolnet/homebrew-deprecated) -- [phpbrew](https://github.com/phpbrew/phpbrew) +- [powershell-phpmanager](https://github.com/mlocati/powershell-phpmanager "Package to handle PHP on windows") +- [Homebrew](https://brew.sh/ "MacOS package manager") +- [ppa:ondrej/php](https://launchpad.net/~ondrej/+archive/ubuntu/php "Pre-compiled ubuntu packages") +- [exolnet/homebrew-deprecated](https://github.com/eXolnet/homebrew-deprecated "Pre-compiled deprecated PHP for macOS") +- [phpbrew](https://github.com/phpbrew/phpbrew "PHP packages manager") ## :bookmark_tabs: Further Reading -- [About GitHub Actions](https://github.com/features/actions) -- [GitHub Actions Syntax](https://help.github.com/en/articles/workflow-syntax-for-github-actions) -- [Other Awesome Actions](https://github.com/sdras/awesome-actions) +- [About GitHub Actions](https://github.com/features/actions "GitHub Actions") +- [GitHub Actions Syntax](https://help.github.com/en/articles/workflow-syntax-for-github-actions "GitHub Actions Syntax") +- [Other Awesome Actions](https://github.com/sdras/awesome-actions "List of Awesome GitHub Actions") diff --git a/examples/codeigniter.yml b/examples/codeigniter.yml index 49947b184..47d4e630c 100644 --- a/examples/codeigniter.yml +++ b/examples/codeigniter.yml @@ -1,3 +1,4 @@ +# GitHub Action for CodeIgniter name: Testing CodeIgniter on: [push, pull_request] jobs: @@ -19,9 +20,6 @@ jobs: coverage: xdebug #optional - name: Install dependencies run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader - - name: Test with phpunit in windows - if: matrix.operating-system == 'windows-latest' - run: .\vendor\bin\phpunit --coverage-text - name: Test with phpunit - if: matrix.operating-system != 'windows-latest' - run: vendor/bin/phpunit --coverage-text \ No newline at end of file + run: vendor/bin/phpunit --coverage-text + shell: pwsh \ No newline at end of file diff --git a/examples/laravel-mysql.yml b/examples/laravel-mysql.yml index 1260f448a..707fb0a35 100644 --- a/examples/laravel-mysql.yml +++ b/examples/laravel-mysql.yml @@ -1,3 +1,4 @@ +# GitHub Action for Laravel with MySQL and Redis name: Testing Laravel with MySQL on: [push, pull_request] jobs: diff --git a/examples/laravel-postgres.yml b/examples/laravel-postgres.yml index 78e9655fe..52b28298c 100644 --- a/examples/laravel-postgres.yml +++ b/examples/laravel-postgres.yml @@ -1,3 +1,4 @@ +# GitHub Action for Laravel with PostgreSQL and Redis name: Testing Laravel with PostgreSQL on: [push, pull_request] jobs: diff --git a/examples/laravel.yml b/examples/laravel.yml index 1f4a8e967..b1e257fb0 100644 --- a/examples/laravel.yml +++ b/examples/laravel.yml @@ -1,4 +1,5 @@ -name: Unit Testing Laravel +# GitHub Action for Laravel +name: Testing Laravel on: [push, pull_request] jobs: laravel: @@ -27,9 +28,6 @@ jobs: php artisan key:generate - name: Clear Config run: php artisan config:clear - - name: Test with phpunit in windows - if: matrix.operating-system == 'windows-latest' - run: .\vendor\bin\phpunit --coverage-text - name: Test with phpunit - if: matrix.operating-system != 'windows-latest' - run: vendor/bin/phpunit --coverage-text \ No newline at end of file + run: vendor/bin/phpunit --coverage-text + shell: pwsh \ No newline at end of file diff --git a/examples/slim-framework.yml b/examples/slim-framework.yml index f3296eb04..9d6790031 100644 --- a/examples/slim-framework.yml +++ b/examples/slim-framework.yml @@ -1,3 +1,4 @@ +# GitHub Action for Slim Framework name: Testing Slim Framework on: [push, pull_request] jobs: @@ -19,9 +20,6 @@ jobs: coverage: xdebug #optional - name: Install dependencies run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader - - name: Test with phpunit in windows - if: matrix.operating-system == 'windows-latest' - run: .\vendor\bin\phpunit --coverage-text - name: Test with phpunit - if: matrix.operating-system != 'windows-latest' - run: vendor/bin/phpunit --coverage-text \ No newline at end of file + run: vendor/bin/phpunit --coverage-text + shell: pwsh \ No newline at end of file diff --git a/examples/symfony-mysql.yml b/examples/symfony-mysql.yml index d2c1c4b8b..9d437f0d7 100644 --- a/examples/symfony-mysql.yml +++ b/examples/symfony-mysql.yml @@ -1,7 +1,8 @@ +# GitHub Action for Symfony with MySQL name: Testing Symfony with MySQL on: [push, pull_request] jobs: - laravel: + symfony: name: Symfony (PHP ${{ matrix.php-versions }}) runs-on: ubuntu-latest services: diff --git a/examples/symfony-postgres.yml b/examples/symfony-postgres.yml index e1286491b..5557f763e 100644 --- a/examples/symfony-postgres.yml +++ b/examples/symfony-postgres.yml @@ -1,7 +1,8 @@ +# GitHub Action for Symfony with PostgreSQL name: Testing Symfony with PostgreSQL on: [push, pull_request] jobs: - laravel: + symfony: name: Symfony (PHP ${{ matrix.php-versions }}) runs-on: ubuntu-latest services: diff --git a/examples/symfony.yml b/examples/symfony.yml index efe464e4a..e8ac1bb70 100644 --- a/examples/symfony.yml +++ b/examples/symfony.yml @@ -1,7 +1,8 @@ -name: Unit Testing Symfony +# GitHub Action for Symfony +name: Testing Symfony on: [push, pull_request] jobs: - laravel: + symfony: name: Symfony (PHP ${{ matrix.php-versions }} on ${{ matrix.operating-system }}) runs-on: ${{ matrix.operating-system }} strategy: diff --git a/examples/yii2-mysql.yml b/examples/yii2-mysql.yml index 752df59cb..e826f7b43 100644 --- a/examples/yii2-mysql.yml +++ b/examples/yii2-mysql.yml @@ -1,7 +1,8 @@ +# GitHub Action for Yii Framework with MySQL name: Testing Yii2 with MySQL on: [push, pull_request] jobs: - laravel: + yii: name: Yii2 (PHP ${{ matrix.php-versions }}) runs-on: ubuntu-latest env: @@ -31,7 +32,7 @@ jobs: - name: Set Node.js 10.x uses: actions/setup-node@master with: - version: 10.x + node-version: 10.x - name: Setup PHP, with composer and extensions uses: shivammathur/setup-php@master #https://github.com/shivammathur/setup-php with: diff --git a/examples/yii2-postgres.yml b/examples/yii2-postgres.yml index 63e530662..205bc426f 100644 --- a/examples/yii2-postgres.yml +++ b/examples/yii2-postgres.yml @@ -1,7 +1,8 @@ +# GitHub Action for Yii Framework with PostgreSQL name: Testing Yii2 with PostgreSQL on: [push, pull_request] jobs: - laravel: + yii: name: Yii2 (PHP ${{ matrix.php-versions }}) runs-on: ubuntu-latest env: @@ -31,7 +32,7 @@ jobs: - name: Set Node.js 10.x uses: actions/setup-node@master with: - version: 10.x + node-version: 10.x - name: Setup PHP, with composer and extensions uses: shivammathur/setup-php@master #https://github.com/shivammathur/setup-php with: diff --git a/examples/zend-framework.yml b/examples/zend-framework.yml index af73c874d..2ff8fd752 100644 --- a/examples/zend-framework.yml +++ b/examples/zend-framework.yml @@ -1,3 +1,4 @@ +# GitHub Action for Zend Framework name: Testing Zend Framework on: [push, pull_request] jobs: @@ -21,9 +22,6 @@ jobs: run: | composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader composer require --dev phpunit/phpunit squizlabs/php_codesniffer zendframework/zend-test - - name: Test with phpunit in windows - if: matrix.operating-system == 'windows-latest' - run: .\vendor\bin\phpunit --coverage-text - name: Test with phpunit - if: matrix.operating-system != 'windows-latest' - run: vendor/bin/phpunit --coverage-text \ No newline at end of file + run: vendor/bin/phpunit --coverage-text + shell: pwsh \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index a9d41a33f..9d1a96691 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "setup-php", - "version": "1.4.0", + "version": "1.4.1", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 3669a01ed..824b934a8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "setup-php", - "version": "1.4.0", + "version": "1.4.1", "private": false, "description": "Setup php action", "main": "lib/setup-php.js", diff --git a/src/scripts/darwin.sh b/src/scripts/darwin.sh index 4914a0d39..ed0a6d199 100644 --- a/src/scripts/darwin.sh +++ b/src/scripts/darwin.sh @@ -1,5 +1,7 @@ export HOMEBREW_NO_INSTALL_CLEANUP=TRUE -brew tap exolnet/homebrew-deprecated >/dev/null 2>&1 +if [ "$1" = "5.6" ] || [ "$1" = "7.0" ]; then + brew tap exolnet/homebrew-deprecated >/dev/null 2>&1 +fi brew install php@"$1" composer >/dev/null 2>&1 brew link --force --overwrite php@"$1" >/dev/null 2>&1 ini_file=$(php --ini | grep "Loaded Configuration" | sed -e "s|.*:s*||" | sed "s/ //g") @@ -8,4 +10,4 @@ sudo chmod 777 "$ini_file" mkdir -p "$(pecl config-get ext_dir)" composer global require hirak/prestissimo >/dev/null 2>&1 php -v -composer -V +composer -V \ No newline at end of file diff --git a/src/scripts/linux.sh b/src/scripts/linux.sh index 20307f1b7..8322c09bb 100644 --- a/src/scripts/linux.sh +++ b/src/scripts/linux.sh @@ -3,7 +3,6 @@ if [ "$version" != "$1" ]; then if [ ! -e "/usr/bin/php$1" ]; then sudo DEBIAN_FRONTEND=noninteractive add-apt-repository ppa:ondrej/php -y >/dev/null 2>&1 sudo DEBIAN_FRONTEND=noninteractive apt update -y >/dev/null 2>&1 - sudo DEBIAN_FRONTEND=noninteractive apt install -y php"$1" curl php"$1"-curl >/dev/null 2>&1 if [ "$1" != "7.4" ]; then sudo DEBIAN_FRONTEND=noninteractive apt install -y php"$1" curl php"$1"-curl >/dev/null 2>&1 else @@ -12,21 +11,21 @@ if [ "$version" != "$1" ]; then fi for tool in php phar phar.phar php-cgi php-config phpize; do if [ -e "/usr/bin/$tool$1" ]; then - sudo update-alternatives --set $tool /usr/bin/"$tool$1" + sudo update-alternatives --set $tool /usr/bin/"$tool$1" & fi done fi if [ ! -e "/usr/bin/composer" ]; then - EXPECTED_SIGNATURE="$(curl -s https://composer.github.io/installer.sig)" - curl -s -L https://getcomposer.org/installer > composer-setup.php - ACTUAL_SIGNATURE="$(php -r "echo hash_file('sha384', 'composer-setup.php');")" + EXPECTED_SIGNATURE="$(curl -s https://composer.github.io/installer.sig)" & + curl -s -L https://getcomposer.org/installer > composer-setup.php & + ACTUAL_SIGNATURE="$(php -r "echo hash_file('sha384', 'composer-setup.php');")" & if [ "$EXPECTED_SIGNATURE" != "$ACTUAL_SIGNATURE" ]; then >&2 echo 'ERROR: Invalid installer signature' else COMPOSER_ALLOW_SUPERUSER=1 - sudo php composer-setup.php --install-dir=/usr/local/bin --filename=composer + sudo php composer-setup.php --install-dir=/usr/local/bin --filename=composer fi rm composer-setup.php fi