actions/setup-php
1
0
Fork 0
mirror of https://github.com/shivammathur/setup-php.git synced 2024-11-23 04:11:06 +07:00
Code Issues Packages Projects Releases Wiki Activity

Improve coverage section in README

Browse Source
This commit is contained in:
Shivam Mathur 2021-12-19 17:09:41 +05:30
parent cca8ad3588
commit 7dadf1bf21
No known key found for this signature in database
GPG Key ID: 3E13E4C8591ACC2A
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -316,7 +316,7 @@ Runs on all [PHP versions supported](#tada-php-support "List of PHP versions sup
coverage: xdebug coverage: xdebug
``` ```
- The latest version of Xdebug compatible with the PHP version is set up by default. - When you specify `coverage: xdebug`, the latest version of Xdebug compatible with the PHP version is set up by default.
- If you need Xdebug 2.x on PHP 7.2, 7.3 or 7.4, you can specify `coverage: xdebug2`. - If you need Xdebug 2.x on PHP 7.2, 7.3 or 7.4, you can specify `coverage: xdebug2`.
```yaml ```yaml
@ -327,6 +327,8 @@ Runs on all [PHP versions supported](#tada-php-support "List of PHP versions sup
coverage: xdebug2 coverage: xdebug2
``` ```
**Note**: Xdebug is enabled by default on Ubuntu GitHub Actions images, so if you are not using it in your workflow it is recommended to disable it as that will have a positive impact on your PHP performance. Please refer to the [disable coverage](#disable-coverage) section for details.
### PCOV ### PCOV
Specify `coverage: pcov` to use `PCOV` and disable `Xdebug`. Specify `coverage: pcov` to use `PCOV` and disable `Xdebug`.
@ -360,7 +362,6 @@ Specify `coverage: none` to disable both `Xdebug` and `PCOV`.
Disable coverage for these reasons: Disable coverage for these reasons:
- You are not generating coverage reports while testing. - 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. - You are using `phpdbg` for running your tests.
- You are profiling your code using `blackfire`. - You are profiling your code using `blackfire`.
- You are using PHP in JIT mode. Please refer to [JIT configuration](#jit-configuration) section for more details. - You are using PHP in JIT mode. Please refer to [JIT configuration](#jit-configuration) section for more details.