Merge pull request #57 from shivammathur/develop

Fix scripts, README and examples

.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

README.md

@@ -7,15 +7,15 @@
 # Setup PHP in GitHub Actions
 
 <p align="left">
-  <a href="https://github.com/shivammathur/setup-php"><img alt="GitHub Actions status" src="https://github.com/shivammathur/setup-php/workflows/Main%20workflow/badge.svg"></a>
+  <a href="https://github.com/shivammathur/setup-php" title="GitHub action to setup PHP"><img alt="GitHub Actions status" src="https://github.com/shivammathur/setup-php/workflows/Main%20workflow/badge.svg"></a>
-  <a href="https://codecov.io/gh/shivammathur/setup-php"><img alt="Codecov Code Coverage" src="https://codecov.io/gh/shivammathur/setup-php/branch/master/graph/badge.svg"></a>
+  <a href="https://codecov.io/gh/shivammathur/setup-php" title="Code coverage"><img alt="Codecov Code Coverage" src="https://codecov.io/gh/shivammathur/setup-php/branch/master/graph/badge.svg"></a>
-  <a href="https://github.com/shivammathur/setup-php/blob/master/LICENSE"><img alt="LICENSE" src="https://img.shields.io/badge/license-MIT-428f7e.svg"></a>
+  <a href="https://github.com/shivammathur/setup-php/blob/master/LICENSE" title="license"><img alt="LICENSE" src="https://img.shields.io/badge/license-MIT-428f7e.svg"></a>
-  <a href="#tada-php-support"><img alt="PHP Versions Supported" src="https://img.shields.io/badge/php-%3E%3D%205.6-8892BF.svg"></a> 
+  <a href="#tada-php-support" title="PHP Versions Supported"><img alt="PHP Versions Supported" src="https://img.shields.io/badge/php-%3E%3D%205.6-8892BF.svg"></a> 
-  <a href="https://www.patreon.com/shivammathur"><img alt="Support me on Patreon" src="https://shivammathur.com/badges/patreon.svg"></a>   <a href="https://www.paypal.me/shivammathur"><img alt="Support me on PayPal" src="https://shivammathur.com/badges/paypal.svg"></a>
+  <a href="https://www.patreon.com/shivammathur" title="Support Shivam Mathur on Patreon"><img alt="Support me on Patreon" src="https://shivammathur.com/badges/patreon.svg"></a>   <a href="https://www.paypal.me/shivammathur"><img alt="Support me on PayPal" src="https://shivammathur.com/badges/paypal.svg"></a>
-  <a href="https://www.codementor.io/shivammathur?utm_source=github&utm_medium=button&utm_term=shivammathur&utm_campaign=github"><img alt="Contact me on Codementor" src="https://cdn.codementor.io/badges/contact_me_github.svg"></a>  
+  <a href="https://www.codementor.io/shivammathur?utm_source=github&utm_medium=button&utm_term=shivammathur&utm_campaign=github" title="Contact Shivam Mathur on Codementor"><img alt="Contact me on Codementor" src="https://cdn.codementor.io/badges/contact_me_github.svg"></a>  
 </p>
 
-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
 
@@ -51,7 +51,7 @@ 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)    
+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`.
+Specify `coverage: pcov` to use `PCOV`.  
-For `pcov.directory` to be other than `src`, `lib` or, `app`, specify it using the `ini-values-csv` input.
+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|
+|Framework/Package|Runs on|Workflow|
-|--- |--- |
+|--- |--- |--- |
-|CodeIgniter|[codeigniter.yml](./examples/codeigniter.yml)|
+|CodeIgniter|`macOS`, `ubuntu` and `windows`|[codeigniter.yml](./examples/codeigniter.yml "GitHub Action for CodeIgniter")|
-|Laravel `MySQL` `Redis`|[laravel-mysql.yml](./examples/laravel-mysql.yml)|
+|Laravel with `MySQL` and `Redis`|`ubuntu`|[laravel-mysql.yml](./examples/laravel-mysql.yml "GitHub Action for Laravel with MySQL and Redis")|
-|Laravel `PostgreSQL` `Redis`|[laravel-postgres.yml](./examples/laravel-postgres.yml)|
+|Laravel with `PostgreSQL` and `Redis`|`ubuntu`|[laravel-postgres.yml](./examples/laravel-postgres.yml "GitHub Action for Laravel with PostgreSQL and Redis")|
-|Laravel|[laravel.yml](./examples/laravel.yml)|
+|Laravel without services|`macOS`, `ubuntu` and `windows`|[laravel.yml](./examples/laravel.yml "GitHub Action for Laravel without services")|
-|Slim Framework|[slim-framework.yml](./examples/slim-framework.yml)|
+|Slim Framework|`macOS`, `ubuntu` and `windows`|[slim-framework.yml](./examples/slim-framework.yml "GitHub Action for Slim Framework")|
-|Symfony `MySQL`|[symfony-mysql.yml](./examples/symfony-mysql.yml)|
+|Symfony with `MySQL`|`ubuntu`|[symfony-mysql.yml](./examples/symfony-mysql.yml "GitHub Action for Symfony with MySQL")|
-|Symfony `PostgreSQL`|[symfony-postgres.yml](./examples/symfony-postgres.yml)|
+|Symfony with `PostgreSQL`|`ubuntu`|[symfony-postgres.yml](./examples/symfony-postgres.yml "GitHub Action for Symfony with PostgreSQL")|
-|Yii2 Starter Kit `MySQL`|[yii2-mysql.yml](./examples/yii2-mysql.yml)|
+|Yii2 Starter Kit with `MySQL`|`ubuntu`|[yii2-mysql.yml](./examples/yii2-mysql.yml "GitHub Action for Yii2 Starter Kit with MySQL")|
-|Yii2 Starter Kit `PostgreSQL`|[yii2-postgres.yml](./examples/yii2-postgres.yml)|
+|Yii2 Starter Kit with `PostgreSQL`|`ubuntu`|[yii2-postgres.yml](./examples/yii2-postgres.yml "GitHub Action for Yii2 Starter Kit with PostgreSQL")|
-|Zend Framework|[zend-framework.yml](./examples/zend-framework.yml)|
+|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)
+- [powershell-phpmanager](https://github.com/mlocati/powershell-phpmanager "Package to handle PHP on windows")
-- [Homebrew](https://brew.sh/)
+- [Homebrew](https://brew.sh/ "MacOS package manager")
-- [ppa:ondrej/php](https://launchpad.net/~ondrej/+archive/ubuntu/php)
+- [ppa:ondrej/php](https://launchpad.net/~ondrej/+archive/ubuntu/php "Pre-compiled ubuntu packages")
-- [exolnet/homebrew-deprecated](https://github.com/eXolnet/homebrew-deprecated)
+- [exolnet/homebrew-deprecated](https://github.com/eXolnet/homebrew-deprecated "Pre-compiled deprecated PHP for macOS")
-- [phpbrew](https://github.com/phpbrew/phpbrew)
+- [phpbrew](https://github.com/phpbrew/phpbrew "PHP packages manager")
 
 ## :bookmark_tabs: Further Reading
 
-- [About GitHub Actions](https://github.com/features/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](https://help.github.com/en/articles/workflow-syntax-for-github-actions "GitHub Actions Syntax")
-- [Other Awesome Actions](https://github.com/sdras/awesome-actions)
+- [Other Awesome Actions](https://github.com/sdras/awesome-actions "List of Awesome GitHub Actions")

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
+        shell: pwsh

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:

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:

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
+        shell: pwsh

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
+        shell: pwsh

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:

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:

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:

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:

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:

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
+        shell: pwsh

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "setup-php",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

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",

src/scripts/darwin.sh

@@ -1,5 +1,7 @@
 export HOMEBREW_NO_INSTALL_CLEANUP=TRUE
+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")

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,15 +11,15 @@ 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)"
+	EXPECTED_SIGNATURE="$(curl -s https://composer.github.io/installer.sig)" &
-	curl -s -L https://getcomposer.org/installer > composer-setup.php
+	curl -s -L https://getcomposer.org/installer > composer-setup.php &
-	ACTUAL_SIGNATURE="$(php -r "echo hash_file('sha384', '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'