Release v1-verbose

Update Node.js dependencies

.eslintrc.json

@@ -1,7 +1,7 @@
 {
   "env": { "node": true, "jest": true },
   "parser": "@typescript-eslint/parser",
-  "parserOptions": { "ecmaVersion": 2020, "sourceType": "module" },
+  "parserOptions": { "ecmaVersion": 2019, "sourceType": "module" },
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/eslint-recommended",
@@ -10,14 +10,7 @@
     "plugin:import/warnings",
     "plugin:import/typescript",
     "plugin:prettier/recommended",
-    "prettier/@typescript-eslint"
+    "prettier"
   ],
-  "plugins": ["@typescript-eslint", "jest"],
+  "plugins": ["@typescript-eslint", "jest"]
-  "rules": {
-    "camelcase": "off",
-    "require-atomic-updates": "off",
-    "@typescript-eslint/ban-ts-ignore": "off",
-    "@typescript-eslint/camelcase": "off",
-    "@typescript-eslint/no-unused-vars": "off"
-  }
 }

.github/CONTRIBUTING.md

@@ -17,13 +17,6 @@ Due to time constraints, you may not always get a quick response. Please do not
 
 ## Coding Guidelines
 
-This project comes with `.prettierrc.json` and `eslintrc.json` configuration files. Please run the following commands to format the code before committing it.
-
-```bash
-$ npm run format
-$ npm run lint
-```
-
 ## Using setup-php from a Git checkout
 
 The following commands can be used to perform the initial checkout of setup-php:
@@ -40,6 +33,19 @@ Install setup-php dependencies using [npm](https://www.npmjs.com/):
 $ npm install
 ```
 
+If you are using `Windows` configure `git` to handle line endings.
+
+```cmd
+git config --local core.autocrlf true
+```
+
+This project comes with `.prettierrc.json` and `eslintrc.json` configuration files. Please run the following commands to fix and verify the code quality.
+
+```bash
+$ npm run format
+$ npm run lint
+```
+
 ## Running the test suite
 
 After following the steps shown above, The `setup-php` tests in the `__tests__` directory can be run using this command:

.github/FUNDING.yml

@@ -1,8 +1,3 @@
 # These are supported funding model platforms
 
-github: shivammathur
+github:shivammathur
-community_bridge: setup-php
-issuehunt: shivammathur
-patreon: shivammathur
-liberapay: shivammathur
-custom: https://www.paypal.me/shivammathur

.github/PULL_REQUEST_TEMPLATE.md

@@ -26,7 +26,12 @@ This PR [briefly explain what it does]
 - [ ] I have run `npm run format` before the commit.
 - [ ] I have run `npm run lint` before the commit.
 - [ ] I have run `npm run release` before the commit.
-- [ ] `npm test` returns with no unit test errors.
+- [ ] `npm test` returns with no unit test errors and all code covered.
+
+> In case this PR edits any scripts:
+
+- [ ] I have checked the edited scripts for syntax.
+- [ ] I have tested the changes in an integration test (If yes, provide workflow YAML and link).
 
 <!--
 - Please target the develop branch when submitting the pull request.

.github/PULL_REQUEST_TEMPLATE/FIX.md

@@ -1,33 +0,0 @@
----
-name: 🐞 Bug Fix
-about: You have a fix for a bug?
-labels: bug
-
----
-
-## A Pull Request should be associated with an Issue.
-
-> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
-> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
-> and potentially we'll be able to point development in a particular direction.
-
-Related issue: 
-
-> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
-> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
-
-### Description
-
-This PR [briefly explain what it does]
-
-> In case this PR introduced TypeScript/JavaScript code changes:
-
-- [ ] I have written test cases for the changes in this pull request.
-- [ ] I have run `npm run format` before the commit.
-- [ ] I have run `npm run lint` before the commit.
-- [ ] I have run `npm run release` before the commit.
-- [ ] `npm test` returns with no unit test errors.
-
-<!--
-- Please target the develop branch when submitting the pull request.
--->

.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md

@@ -1,33 +0,0 @@
----
-name: ⚙ Improvement
-about: You have some improvement to make setup-php better?
-labels: enhancement
-
----
-
-## A Pull Request should be associated with an Issue.
-
-> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
-> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
-> and potentially we'll be able to point development in a particular direction.
-
-Related issue: 
-
-> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
-> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
-
-### Description
-
-This PR [briefly explain what it does]
-
-> In case this PR introduced TypeScript/JavaScript code changes:
-
-- [ ] I have written test cases for the changes in this pull request.
-- [ ] I have run `npm run format` before the commit.
-- [ ] I have run `npm run lint` before the commit.
-- [ ] I have run `npm run release` before the commit.
-- [ ] `npm test` returns with no unit test errors.
-
-<!--
-- Please target the develop branch when submitting the pull request.
--->

.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md

@@ -1,33 +0,0 @@
----
-name: 🎉 New Feature
-about: You have implemented some neat idea that you want to make part of setup-php?
-labels: enhancement
-
----
-
-## A Pull Request should be associated with an Issue.
-
-> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
-> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
-> and potentially we'll be able to point development in a particular direction.
-
-Related issue: 
-
-> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
-> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
-
-### Description
-
-This PR [briefly explain what it does]
-
-> In case this PR introduced TypeScript/JavaScript code changes:
-
-- [ ] I have written test cases for the changes in this pull request.
-- [ ] I have run `npm run format` before the commit.
-- [ ] I have run `npm run lint` before the commit.
-- [ ] I have run `npm run release` before the commit.
-- [ ] `npm test` returns with no unit test errors.
-
-<!--
-- Please target the develop branch when submitting the pull request.
--->

.github/SECURITY.md

@@ -0,0 +1,30 @@
+# Security Policy
+
+## Supported Versions
+
+The following versions of this project are supported for security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.11.x  | :white_check_mark: |
+| 2.14.x  | :white_check_mark: |
+
+## Supported PHP Versions
+
+This security policy only applies to the latest patches of the following PHP versions.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 7.3     | :white_check_mark: |
+| 7.4     | :white_check_mark: |
+| 8.0     | :white_check_mark: |
+| 8.1     | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you have found any issues that might have security implications in the versions supported, please send a report privately to [contact@shivammathur.com](mailto:contact@shivammathur.com).
+Do not report security reports publicly.
+
+## Tidelift
+
+If you use this GitHub Action through a Tidelift subscription, please refer to [https://tidelift.com/security](https://tidelift.com/security).

.github/codeql/codeql-configuration.yml

@@ -0,0 +1,4 @@
+name : CodeQL Configuration
+
+paths:
+  - './src'

.github/workflows/codeql-workflow.yml

@@ -0,0 +1,25 @@
+name: CodeQL Workflow
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 15 * * 6'
+jobs:
+  codeql:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 2
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          config-file: ./.github/codeql/codeql-configuration.yml
+          languages: javascript
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

.github/workflows/experimental-workflow.yml

@@ -1,92 +0,0 @@
-name: Experimental workflow
-on:
-  pull_request:
-    branches:
-      - nightly
-      - master
-      - develop
-      - verbose
-    paths-ignore:
-      - '**.md'
-      - 'examples/**'
-  push:
-    branches:
-      - nightly
-      - master
-      - develop
-      - verbose
-    paths-ignore:
-      - '**.md'
-      - 'examples/**'
-jobs:
-  run:
-    name: Run
-    runs-on: ${{ matrix.operating-system }}
-    strategy:
-      fail-fast: false
-      matrix:
-        operating-system: [ubuntu-latest, windows-latest, macos-latest]
-        php-versions: ['8.0']
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Setup Node.js 12.x
-        uses: actions/setup-node@v1
-        with:
-          node-version: 12.x
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Prettier Format Check
-        run: npm run format-check
-
-      - name: ESLint Check
-        run: npm run lint
-
-      - name: Run tests
-        run: npm test
-
-      - name: Send Coverage
-        continue-on-error: true
-        timeout-minutes: 1
-        run: curl -s https://codecov.io/bash | bash -s -- -t ${{secrets.CODECOV_TOKEN}} -f coverage/clover.xml -n github-actions-codecov-${{ matrix.operating-system }}-php${{ matrix.php-versions }}
-
-      - name: Setup PHP with extensions and custom config
-        run: node dist/index.js
-        env:
-          php-version: ${{ matrix.php-versions }}
-          extensions: xml, opcache, xdebug, pcov #optional
-          ini-values: post_max_size=256M, short_open_tag=On, date.timezone=Asia/Kolkata #optional
-          coverage: pcov
-
-      - name: Testing PHP version
-        run: |
-          php -v
-          php -r "if(strpos(phpversion(), '${{ matrix.php-versions }}') === false) {throw new Exception('Wrong PHP version Installed');}"
-
-      - name: Testing Composer version
-        run: |
-          composer -V
-          php -r "if(strpos(@exec('composer -V'), 'Composer version') === false) {throw new Exception('Composer not found');}"
-      - name: Testing Extensions
-        run: |
-          php -m
-          php -r "if(! extension_loaded('mbstring')) {throw new Exception('mbstring not found');}"
-          php -r "if(! extension_loaded('pcov')) {throw new Exception('PCOV not found');}"
-      - name: Testing ini values
-        run: |
-          php -r "if(ini_get('post_max_size')!='256M') {throw new Exception('post_max_size not added');}"
-          php -r "if(ini_get('short_open_tag')!=1) {throw new Exception('short_open_tag not added');}"
-          php -r "if(ini_get('date.timezone')!='Asia/Kolkata') {throw new Exception('date.timezone not added');}"
-      - name: Test JIT
-        run: |
-          php -r "if(! extension_loaded('Zend OPcache')) {throw new Exception('Zend OPcache not found');}"
-          php -r "if(ini_get('opcache.jit_buffer_size')!='256M') {throw new Exception('opcache.jit_buffer_size not set');}"
-          php -r "if(ini_get('opcache.jit')!=1235) {throw new Exception('opcache.jit not set');}"
-          php -r "if(ini_get('pcre.jit')!=1) {throw new Exception('pcre.jit not set');}"
-      - name: Benchmark JIT
-        run: |
-          curl -o bench.php https://raw.githubusercontent.com/php/php-src/master/Zend/bench.php
-          php bench.php

.github/workflows/main-workflow.yml

@@ -1,18 +1,15 @@
 name: Main workflow
 on:
+  workflow_dispatch:
   pull_request:
     branches:
-      - master
+      - releases/v1
-      - develop
-      - verbose
     paths-ignore:
       - '**.md'
       - 'examples/**'
   push:
     branches:
-      - master
+      - releases/v1
-      - develop
-      - verbose
     paths-ignore:
       - '**.md'
       - 'examples/**'
@@ -23,34 +20,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        operating-system: [ubuntu-latest, windows-latest, macos-latest]
+        operating-system: [ubuntu-20.04, ubuntu-18.04, windows-latest, macos-latest]
-        php-versions: ['5.6', '7.0', '7.1', '7.2', '7.3', '7.4']
+        php-versions: ['5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0']
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Setup Node.js 12.x
-        uses: actions/setup-node@v1
-        with:
-          node-version: 12.x
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Prettier Format Check
-        run: npm run format-check
-
-      - name: ESLint Check
-        run: npm run lint
-
-      - name: Run tests
-        run: npm test
-
-      - name: Send Coverage
-        continue-on-error: true
-        timeout-minutes: 1
-        run: curl -s https://codecov.io/bash | bash -s -- -t ${{secrets.CODECOV_TOKEN}} -f coverage/clover.xml -n github-actions-codecov-${{ matrix.operating-system }}-php${{ matrix.php-versions }}
-
       - name: Setup PHP with extensions and custom config
         run: node dist/index.js
         env:
@@ -75,6 +50,7 @@ jobs:
           php -r "if(phpversion()>=7.1 && ! extension_loaded('pcov')) {throw new Exception('PCOV not found');}"
       - name: Testing ini values
         run: |
+          php -r "if(ini_get('memory_limit')!='-1') {throw new Exception('memory_limit not disabled');}"
           php -r "if(ini_get('post_max_size')!='256M') {throw new Exception('post_max_size not added');}"
           php -r "if(ini_get('short_open_tag')!=1) {throw new Exception('short_open_tag not added');}"
           php -r "if(ini_get('date.timezone')!='Asia/Kolkata') {throw new Exception('date.timezone not added');}"

.github/workflows/node-workflow.yml

@@ -0,0 +1,54 @@
+name: Node workflow
+on:
+  pull_request:
+    branches:
+      - releases/v1
+    paths-ignore:
+      - '**.md'
+      - 'examples/**'
+  push:
+    branches:
+      - releases/v1
+    paths-ignore:
+      - '**.md'
+      - 'examples/**'
+jobs:
+  run:
+    name: Run
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      fail-fast: false
+      matrix:
+        operating-system: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js 16.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16.x
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Prettier Format Check
+        run: npm run format-check
+
+      - name: ESLint Check
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test
+
+      - name: Run npm audit
+        run: npm audit
+
+      - name: Send Coverage
+        uses: codecov/codecov-action@v2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage/lcov.info
+          name: github-actions-codecov-${{ matrix.operating-system }}
+          fail_ci_if_error: false
+          verbose: true

.prettierrc.json

@@ -1,11 +1,12 @@
 {
+    "arrowParens": "avoid",
+    "bracketSpacing": false,
+    "endOfLine": "auto",
+    "parser": "typescript",
     "printWidth": 80,
-    "tabWidth": 2,
-    "useTabs": false,
     "semi": true,
     "singleQuote": true,
+    "tabWidth": 2,
     "trailingComma": "none",
-    "bracketSpacing": false,
+    "useTabs": false
-    "arrowParens": "avoid",
+}
-    "parser": "typescript"
-  }

README.md

@@ -8,7 +8,7 @@
 
 <p align="center">
   <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" 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://codecov.io/gh/shivammathur/setup-php" title="Code coverage"><img alt="Codecov Code Coverage" src="https://img.shields.io/codecov/c/github/shivammathur/setup-php?logo=codecov"></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" title="PHP Versions Supported"><img alt="PHP Versions Supported" src="https://img.shields.io/badge/php-%3E%3D%205.6-8892BF.svg"></a>
 </p>
@@ -18,49 +18,50 @@ Setup PHP with required extensions, php.ini configuration, code-coverage support
 ## Contents
 
 - [PHP Support](#tada-php-support)
-- [OS/Platform Support](#cloud-osplatform-support)
+- [GitHub-Hosted Runner Support](#cloud-github-hosted-runner-support)
 - [PHP Extension Support](#heavy_plus_sign-php-extension-support)
 - [Tools Support](#wrench-tools-support)
-- [Coverage support](#signal_strength-coverage-support)
+- [Coverage Support](#signal_strength-coverage-support)
   - [Xdebug](#xdebug)
   - [PCOV](#pcov)
   - [Disable coverage](#disable-coverage)
 - [Usage](#memo-usage)
   - [Basic Setup](#basic-setup)
   - [Matrix Setup](#matrix-setup)
-  - [Experimental Setup](#experimental-setup)
   - [Thread Safe Setup](#thread-safe-setup)  
-  - [Cache dependencies](#cache-dependencies)
+  - [Cache Dependencies](#cache-dependencies)
+  - [Composer GitHub OAuth](#composer-github-oauth)  
   - [Problem Matchers](#problem-matchers)
   - [Examples](#examples)
 - [License](#scroll-license)
 - [Contributions](#1-contributions)
-- [Support this project](#sparkling_heart-support-this-project)
+- [Support This project](#sparkling_heart-support-this-project)
-- [This action uses the following works](#bookmark-this-action-uses-the-following-works)
+- [Dependencies](#bookmark-dependencies)
 - [Further Reading](#bookmark_tabs-further-reading)
 
 ## :tada: PHP Support
 
-|PHP Version|Stability|Release Support|
+| PHP Version | Stability | Release Support       |
-|--- |--- |--- |
+|-------------|-----------|-----------------------|
-|5.6|`Stable`|`End of life`|
+| 5.6         | `Stable`  | `End of life`         |
-|7.0|`Stable`|`End of life`|
+| 7.0         | `Stable`  | `End of life`         |
-|7.1|`Stable`|`End of life`|
+| 7.1         | `Stable`  | `End of life`         |
-|7.2|`Stable`|`Security fixes only`|
+| 7.2         | `Stable`  | `End of life`         |
-|7.3|`Stable`|`Active`|
+| 7.3         | `Stable`  | `End of life`         |
-|7.4|`Stable`|`Active`|
+| 7.4         | `Stable`  | `Security fixes only` |
-|8.0|`Experimental`|`In development`|
+| 8.0         | `Stable`  | `Active`              |
 
-**Note:** Specifying `8.0` in `php-version` input installs a nightly build of `PHP 8.0.0-dev` with `PHP JIT`, `Union Types v2` and other [new features](https://wiki.php.net/rfc#php_80 "New features implemented in PHP 8"). See [experimental setup](#experimental-setup) for more information.
+## :cloud: GitHub-Hosted Runner Support
 
-## :cloud: OS/Platform Support
+| Virtual environment  | YAML workflow label                | Pre-installed PHP      |
-
+|----------------------|------------------------------------|------------------------|
-|Virtual environment|matrix.operating-system|
+| Ubuntu 20.04         | `ubuntu-latest` or `ubuntu-20.04`  | `PHP 7.4` to `PHP 8.1` |
-|--- |--- |
+| Ubuntu 18.04         | `ubuntu-18.04`                     | `PHP 7.2` to `PHP 8.1` |
-|Windows Server 2019|`windows-latest` or `windows-2019`|
+| Windows Server 2022  | `windows-latest` or `windows-2022` | `PHP 8.1`              |
-|Ubuntu 18.04|`ubuntu-latest` or `ubuntu-18.04`|
+| Windows Server 2019  | `windows-2019`                     | `PHP 8.1`              |
-|Ubuntu 16.04|`ubuntu-16.04`|
+| macOS Monterey 12.x  | `macos-12`                         | `PHP 8.1`              |
-|macOS X Catalina 10.15|`macos-latest` or `macOS-10.15`|
+| macOS Big Sur 11.x   | `macos-latest` or `macos-11`       | `PHP 8.1`              |
+| macOS Catalina 10.15 | `macos-10.15`                      | `PHP 8.1`              |
 
 ## :heavy_plus_sign: PHP Extension Support
 - On `ubuntu` by default extensions which are available as a package can be installed. If the extension is not available as a package but it is on `PECL`, it can be installed by specifying `pecl` in the tools input.
@@ -83,28 +84,36 @@ with:
   tools: php-cs-fixer, phpunit
 ```
 
-To setup a particular version of a tool, specify it in the form `tool:version`.  
+To set up a particular version of a tool, specify it in the form `tool:version`. 
-Version should be in semver format and a valid release of the tool.
+
+The latest stable version of `composer` is set up by default. You can set up the required `composer` version by specifying `v1`, `v2`, `snapshot` or `preview` as versions or the exact version in semver format.
 
 ```yaml
 uses: shivammathur/setup-php@v1
 with:
   php-version: '7.4'
-  tools: php-cs-fixer:2.15.5, phpunit:8.5.1
+  tools: composer:v2
 ```
 
-**Note**
+If you have specified composer plugins `prestissimo` or `composer-prefetcher` in tools, the latest stable version of `composer v1` will be setup. Unless some of your packages require `composer v1`, it is recommended to drop `prestissimo` and use `composer v2`.
-- `composer` is setup by default.
-- Specifying version for `composer` and `pecl` has no effect, latest version of both tools will be setup.
-- If the version specified for the tool is not in semver format, latest version of the tool will be setup.
-- Tools which cannot be installed gracefully leave an error message in the logs, the action is not interrupted.
 
-## :signal_strength: Coverage support
+Version for other tools should be in `semver` format and a valid release of the tool.
+
+```yaml
+uses: shivammathur/setup-php@v1
+with:
+  php-version: '7.4'
+  tools: php-cs-fixer:2.16.2, phpunit:8.5.1
+```
+
+Tools 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](#tada-php-support "List of PHP versions supported on this GitHub Action") except `8.0`.
+Runs on all [PHP versions supported](#tada-php-support "List of PHP versions supported on this GitHub Action").
 
 ```yaml
 uses: shivammathur/setup-php@v1
@@ -129,7 +138,7 @@ with:
   coverage: pcov
 ```
 
-### Disable coverage
+### Disable Coverage
 
 Specify `coverage: none` to disable both `Xdebug` and `PCOV`.  
 Consider disabling the coverage using this PHP action for these reasons.
@@ -203,31 +212,6 @@ jobs:
         tools: php-cs-fixer, phpunit #optional, setup tools globally
 ```
 
-### Experimental Setup
-
-> Setup a nightly build of `PHP 8.0.0-dev` from the [master branch](https://github.com/php/php-src/tree/master "Master branch on PHP source repository") of PHP.
-
-- This version is currently in development and is an experimental feature on this action.
-- `PECL` is installed by default with this version on `ubuntu`.
-- Some extensions might not support this version currently.
-- Refer to this [RFC](https://wiki.php.net/rfc/jit "PHP JIT RFC configuration") for configuring `PHP JIT` on this version.
-- Refer to this [list of RFCs](https://wiki.php.net/rfc#php_80 "List of RFCs implemented in PHP8") implemented in this version.
-
-```yaml
-steps:
-- name: Checkout
-  uses: actions/checkout@v2
-
-- name: Setup PHP
-  uses: shivammathur/setup-php@v1
-  with:
-    php-version: '8.0'
-    extensions: mbstring #optional, setup extensions
-    ini-values: opcache.jit_buffer_size=256M, opcache.jit=1235, pcre.jit=1 #optional, setup php.ini configuration
-    coverage: pcov #optional, setup PCOV, Xdebug does not support this version yet.
-    tools: php-cs-fixer, phpunit #optional, setup tools globally    
-```
-
 ### Thread Safe Setup
 
 - `NTS` versions are setup by default.
@@ -248,10 +232,10 @@ jobs:
       with:
         php-version: '7.4'
       env:
-        PHPTS: ts # specify ts or nts
+        phpts: ts # specify ts or nts
 ```
 
-### Cache dependencies
+### Cache Dependencies
 
 You can persist composer's internal cache directory using the [`action/cache`](https://github.com/actions/cache "GitHub Action to cache files") 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.
 
@@ -263,7 +247,7 @@ You can persist composer's internal cache directory using the [`action/cache`](h
   run: echo "::set-output name=dir::$(composer config cache-files-dir)"
 
 - name: Cache dependencies
-  uses: actions/cache@v1
+  uses: actions/cache@v2
   with:
     path: ${{ steps.composer-cache.outputs.dir }}
     key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
@@ -273,92 +257,183 @@ You can persist composer's internal cache directory using the [`action/cache`](h
   run: composer install --prefer-dist
 ```
 
-In the above example, if you support a range of `composer` dependencies and do not commit `composer.lock`, you can use the hash of `composer.json` as the key for your cache.
+- If you do not commit `composer.lock`, you can use the hash of `composer.json` as the key for your cache.
-
 ```yaml
 key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
 ```
 
+- If you support a range of `composer` dependencies and use `prefer-lowest` and `prefer-stable` options, you can store them in your matrix add them to the keys.
+```yaml
+key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}-${{ matrix.prefer }}-
+restore-keys: ${{ runner.os }}-composer-${{ matrix.prefer }}-
+```
+
+### Composer GitHub OAuth
+
+If you have a number of workflows which setup multiple tools or have many composer dependencies, you might hit the GitHub's rate limit for composer. To avoid that you can add a `OAuth` token to the composer's config by setting `COMPOSER_TOKEN` environment variable. You can use [`GITHUB_TOKEN`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token "GITHUB_TOKEN documentation") secret for this purpose.
+
+```yaml
+- name: Setup PHP
+  uses: shivammathur/setup-php@v2
+  with:
+    php-version: '7.4'
+  env:
+    COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
 ### Problem Matchers
 
+Problem matchers are `json` configurations which identify errors and warnings in your logs and surface that information prominently in the GitHub Actions UI by highlighting them and creating code annotations.
+
+#### PHP
+
+Setup problem matchers for your `PHP` output by adding this step after the `setup-php` step.
+
+```yaml
+- name: Setup problem matchers for PHP
+  run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+```
+
 #### PHPUnit
 
-You can setup problem matchers for your `PHPUnit` output by adding this step after the `setup-php` step. This will scan the logs for failing tests and surface that information prominently in the GitHub Actions UI by creating annotations and log file decorations.
+Setup problem matchers for your `PHPUnit` output by adding this step after the `setup-php` step.
 
 ```yaml
-- name: Setup Problem Matchers for PHPUnit
+- name: Setup problem matchers for PHPUnit
   run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 ```
 
-#### Other tools
+#### PHPStan
+
+PHPStan supports error reporting in GitHub Actions, so no problem matchers are required.
+
+```yaml
+- name: Setup PHP
+  uses: shivammathur/setup-php@v2
+  with:
+    php-version: '7.4'
+    tools: phpstan
+
+- name: Run PHPStan
+  run: phpstan analyse src
+```
+
+#### Psalm
+
+Psalm supports error reporting in GitHub Actions with an output format `github`.
+
+```yaml
+- name: Setup PHP
+  uses: shivammathur/setup-php@v2
+  with:
+    php-version: '7.4'
+    tools: psalm
+
+- name: Run Psalm
+  run: psalm --output-format=github
+```
+
+#### Tools with checkstyle support
 
 For tools that support `checkstyle` reporting like `phpstan`, `psalm`, `php-cs-fixer` and `phpcs` you can use `cs2pr` to annotate your code.  
 For examples refer to [cs2pr documentation](https://github.com/staabm/annotate-pull-request-from-checkstyle).   
 
-> Here is an example with `phpstan`.
+> Here is an example with `phpcs`.
 
 ```yaml
 - name: Setup PHP
-  uses: shivammathur/setup-php@v1
+  uses: shivammathur/setup-php@v2
   with:
     php-version: '7.4'
-    tools: cs2pr, phpstan
+    tools: cs2pr, phpcs
 
-- name: PHPStan
+- name: Run phpcs
-  run: phpstan analyse src --error-format=checkstyle | cs2pr
+  run: phpcs -q --report=checkstyle src | cs2pr
 ```
 
 ### Examples
 
 Examples for setting up this GitHub Action with different PHP Frameworks/Packages.
 
-|Framework/Package|Runs on|Workflow|
+| Framework/Package                     | Runs on                         | Workflow                                                                                                      |
-|--- |--- |--- |
+|---------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------|
-|CakePHP with `MySQL` and `Redis`|`ubuntu`|[cakephp-mysql.yml](./examples/cakephp-mysql.yml "GitHub Action for CakePHP with MySQL and Redis")|
+| CakePHP with `MySQL` and `Redis`      | `ubuntu`                        | [cakephp-mysql.yml](./examples/cakephp-mysql.yml "GitHub Action for CakePHP with MySQL and Redis")            |
-|CakePHP with `PostgreSQL` and `Redis`|`ubuntu`|[cakephp-postgres.yml](./examples/cakephp-postgres.yml "GitHub Action for CakePHP with Postgres and Redis")|
+| CakePHP with `PostgreSQL` and `Redis` | `ubuntu`                        | [cakephp-postgres.yml](./examples/cakephp-postgres.yml "GitHub Action for CakePHP with Postgres and Redis")   |
-|CakePHP without services|`macOS`, `ubuntu` and `windows`|[cakephp.yml](./examples/cakephp.yml "GitHub Action for CakePHP without services")|
+| CakePHP without services              | `macOS`, `ubuntu` and `windows` | [cakephp.yml](./examples/cakephp.yml "GitHub Action for CakePHP without services")                            |
-|CodeIgniter|`macOS`, `ubuntu` and `windows`|[codeigniter.yml](./examples/codeigniter.yml "GitHub Action for CodeIgniter")|
+| 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 `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 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")|
+| 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 `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 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")|
+| 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 `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")|
+| Phalcon with `PostgreSQL`             | `ubuntu`                        | [phalcon-postgres.yml](./examples/phalcon-postgres.yml "GitHub Action for Phalcon with PostgreSQL")           |
-|Roots/bedrock|`ubuntu`|[bedrock.yml](./examples/bedrock.yml "GitHub Action for Wordpress Development using @roots/bedrock")|
+| Roots/bedrock                         | `ubuntu`                        | [bedrock.yml](./examples/bedrock.yml "GitHub Action for Wordpress Development using @roots/bedrock")          |
-|Roots/sage|`ubuntu`|[sage.yml](./examples/sage.yml "GitHub Action for Wordpress Development using @roots/sage")|
+| Roots/sage                            | `ubuntu`                        | [sage.yml](./examples/sage.yml "GitHub Action for Wordpress Development using @roots/sage")                   |
-|Slim Framework|`macOS`, `ubuntu` and `windows`|[slim-framework.yml](./examples/slim-framework.yml "GitHub Action for Slim Framework")|
+| 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 `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")|
+| Symfony with `PostgreSQL`             | `ubuntu`                        | [symfony-postgres.yml](./examples/symfony-postgres.yml "GitHub Action for Symfony with PostgreSQL")           |
-|Symfony without services|`macOS`, `ubuntu` and `windows`|[symfony.yml](./examples/symfony.yml "GitHub Action for Symfony without services")|
+| Symfony without services              | `macOS`, `ubuntu` and `windows` | [symfony.yml](./examples/symfony.yml "GitHub Action for Symfony without services")                            |
-|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 `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")|
+| 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")|
+| 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](https://github.com/shivammathur/setup-php/network/dependencies "Dependencies for this PHP Action") and uses [various works](#bookmark-this-action-uses-the-following-works "Tools used by this action"). 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](#bookmark-dependencies "Dependencies for this PHP Action"). Their licenses can be found in their respective repositories.
+- The logo for `setup-php` is a derivative work of [php.net logo](https://www.php.net/download-logos.php) and is licensed under the [CC BY-SA 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/ "Creative Commons License").
 
 ## :+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](https://github.com/shivammathur/setup-php/issues "Issues reported").
 
-## :sparkling_heart: Support this project
 
-If this action helped you.
+## :sparkling_heart: Support This Project
 
-- Please star the project and share it with the community.
+- Please star the project and share it. If you blog, please share your experience of using `setup-php`.
-- If you blog, write about your experience while using this action.
+- Please [reach out](mailto:contact@setup-php.com) if you have any questions about sponsoring setup-php.
-- I maintain this in my free time, please support me with a [Patreon](https://www.patreon.com/shivammathur "Shivam Mathur Patreon") subscription or a one time contribution using [Paypal](https://www.paypal.me/shivammathur "Shivam Mathur PayPal").
-- If you need any help using this, please contact me using [Codementor](https://www.codementor.io/shivammathur "Shivam Mathur Codementor")
 
-## :bookmark: This action uses the following works
+Many users and organisations support setup-php via [GitHub Sponsors](https://github.com/sponsors/shivammathur).
 
-- [ppa:ondrej/php](https://launchpad.net/~ondrej/+archive/ubuntu/php "Pre-compiled ubuntu packages")
+<a href="https://github.com/sponsors/shivammathur"><img src="https://setup-php.com/sponsors.svg?" alt="Sponsor shivammathur"></a>
-- [shivammathur/php-builder](https://github.com/shivammathur/php-builder "Pre-compiled nightly PHP builds")
+
+These companies generously provide setup-php their products and services to aid in the development of this project.
+
+<p>
+  <a href="https://www.jetbrains.com/?from=setup-php">
+    <img src="https://setup-php.com/sponsors/jetbrains.svg" alt="JetBrains" width="106" height="60">
+  </a>
+  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://www.macstadium.com/opensource/members#gh-light-mode-only">
+    <img src="https://setup-php.com/sponsors/macstadium.png" alt="Mac Stadium" width="148" height="60">
+  </a>
+  <a href="https://www.macstadium.com/opensource/members#gh-dark-mode-only">
+    <img src="https://setup-php.com/sponsors/macstadium-white.png" alt="Mac Stadium" width="148" height="60">
+  </a>
+  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://tidelift.com/subscription/pkg/npm-setup-php">
+    <img src="https://setup-php.com/sponsors/tidelift.png" alt="Tidelift" width="70" height="60">
+  </a>
+  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://www.scaleway.com/en/about-us/open-source-program#gh-light-mode-only">
+    <img src="https://setup-php.com/sponsors/scaleway.png" alt="Scaleway" width="174" height="60">
+  </a>
+  <a href="https://www.scaleway.com/en/about-us/open-source-program#gh-dark-mode-only">
+    <img src="https://setup-php.com/sponsors/scaleway-white.png" alt="Scaleway" width="174" height="60">
+  </a>
+</p>
+
+## :bookmark: Dependencies
+
+- [Node.js dependencies](https://github.com/shivammathur/setup-php/network/dependencies "Node.js dependencies")
+- [aaronparker/VcRedist](https://github.com/aaronparker/VcRedist "VcRedist PowerShell package")
 - [mlocati/powershell-phpmanager](https://github.com/mlocati/powershell-phpmanager "Package to handle PHP on windows")
+- [ppa:ondrej/php](https://launchpad.net/~ondrej/+archive/ubuntu/php "Packaging active PHP packages")
 - [shivammathur/homebrew-php](https://github.com/shivammathur/homebrew-php "Tap for PHP builds for MacOS")
+- [shivammathur/homebrew-extensions](https://github.com/shivammathur/homebrew-extensions "Tap for PHP extensions for MacOS")
+- [shivammathur/php-builder](https://github.com/shivammathur/php-builder "Nightly PHP package")
 
 ## :bookmark_tabs: Further Reading
 

__tests__/config.test.ts

@@ -12,9 +12,9 @@ describe('Config tests', () => {
 
     win32 = await config.addINIValues(
       'post_max_size=256M, short_open_tag=On, date.timezone=Asia/Kolkata',
-      'fedora'
+      'openbsd'
     );
-    expect(win32).toContain('Platform fedora is not supported');
+    expect(win32).toContain('Platform openbsd is not supported');
   });
 
   it('checking addINIValuesOnLinux', async () => {
@@ -29,9 +29,9 @@ describe('Config tests', () => {
 
     linux = await config.addINIValues(
       'post_max_size=256M, short_open_tag=On, date.timezone=Asia/Kolkata',
-      'fedora'
+      'openbsd'
     );
-    expect(linux).toContain('Platform fedora is not supported');
+    expect(linux).toContain('Platform openbsd is not supported');
   });
 
   it('checking addINIValuesOnDarwin', async () => {
@@ -45,8 +45,8 @@ describe('Config tests', () => {
 
     darwin = await config.addINIValues(
       'post_max_size=256M, short_open_tag=On, date.timezone=Asia/Kolkata',
-      'fedora'
+      'openbsd'
     );
-    expect(darwin).toContain('Platform fedora is not supported');
+    expect(darwin).toContain('Platform openbsd is not supported');
   });
 });

__tests__/coverage.test.ts

@@ -1,15 +1,9 @@
 import * as coverage from '../src/coverage';
 
-jest.mock('../src/extensions', () => ({
-  addExtension: jest.fn().mockImplementation(extension => {
-    return 'add_extension ' + extension + '\n';
-  })
-}));
-
 describe('Config tests', () => {
   it('checking addCoverage with PCOV on windows', async () => {
     let win32: string = await coverage.addCoverage('PCOV', '7.4', 'win32');
-    expect(win32).toContain('add_extension pcov');
+    expect(win32).toContain('Add-Extension pcov');
     expect(win32).toContain('Remove-Extension xdebug');
 
     win32 = await coverage.addCoverage('pcov', '7.0', 'win32');
@@ -27,28 +21,38 @@ describe('Config tests', () => {
 
   it('checking addCoverage with PCOV on darwin', async () => {
     const darwin: string = await coverage.addCoverage('pcov', '7.4', 'darwin');
-    expect(darwin).toContain('add_extension pcov');
+    expect(darwin).toContain('add_brew_extension pcov');
     expect(darwin).toContain('remove_extension xdebug');
   });
 
   it('checking addCoverage with Xdebug on windows', async () => {
     const win32: string = await coverage.addCoverage('xdebug', '7.4', 'win32');
-    expect(win32).toContain('add_extension xdebug');
+    expect(win32).toContain('Add-Extension xdebug');
   });
 
-  it('checking addCoverage with Xdebug on windows', async () => {
+  it('checking addCoverage with Xdebug3 on windows', async () => {
-    const win32: string = await coverage.addCoverage('xdebug', '8.0', 'win32');
+    const win32: string = await coverage.addCoverage('xdebug3', '7.4', 'win32');
-    expect(win32).toContain('Xdebug currently only supports PHP 7.4 or lower');
+    expect(win32).toContain('Add-Extension xdebug');
   });
 
-  it('checking addCoverage with Xdebug on linux', async () => {
+  it('checking addCoverage with Xdebug2 on windows', async () => {
-    const linux: string = await coverage.addCoverage('xdebug', '7.4', 'linux');
+    const win32: string = await coverage.addCoverage('xdebug2', '7.4', 'win32');
-    expect(linux).toContain('add_extension xdebug');
+    expect(win32).toContain('Add-Extension xdebug stable 2.9.8');
   });
 
   it('checking addCoverage with Xdebug on linux', async () => {
     const linux: string = await coverage.addCoverage('xdebug', '8.0', 'linux');
-    expect(linux).toContain('Xdebug currently only supports PHP 7.4 or lower');
+    expect(linux).toContain('add_extension xdebug');
+  });
+
+  it('checking addCoverage with Xdebug3 on linux', async () => {
+    const linux: string = await coverage.addCoverage('xdebug3', '8.0', 'linux');
+    expect(linux).toContain('add_extension xdebug');
+  });
+
+  it('checking addCoverage with Xdebug2 on linux', async () => {
+    const linux: string = await coverage.addCoverage('xdebug2', '7.4', 'linux');
+    expect(linux).toContain('add_pecl_extension xdebug 2.9.8 zend_extension');
   });
 
   it('checking addCoverage with Xdebug on darwin', async () => {
@@ -57,16 +61,25 @@ describe('Config tests', () => {
       '7.4',
       'darwin'
     );
-    expect(darwin).toContain('add_extension xdebug');
+    expect(darwin).toContain('add_brew_extension xdebug');
   });
 
-  it('checking addCoverage with Xdebug on darwin', async () => {
+  it('checking addCoverage with Xdebug3 on darwin', async () => {
     const darwin: string = await coverage.addCoverage(
-      'xdebug',
+      'xdebug3',
-      '8.0',
+      '7.4',
       'darwin'
     );
-    expect(darwin).toContain('Xdebug currently only supports PHP 7.4 or lower');
+    expect(darwin).toContain('add_brew_extension xdebug');
+  });
+
+  it('checking addCoverage with Xdebug2 on darwin', async () => {
+    const darwin: string = await coverage.addCoverage(
+      'xdebug2',
+      '7.4',
+      'darwin'
+    );
+    expect(darwin).toContain('add_brew_extension xdebug2');
   });
 
   it('checking disableCoverage windows', async () => {