Skip to content

Update PHPUnit config description #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timkrase merged 2 commits into from
Dec 10, 2024
+22 −9
Merged

Update PHPUnit config description #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bdd428
#21 Update PHPUnit config description
1stthomas Dec 3, 2024
d3d24f2
#21 Re add v9 description to help users which are still using an old …
1stthomas Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,29 @@ Basic configuration for the checkout action works like this:
```
IMPORTANT: v1.0.0 currently has NO support for a custom checkout path.

You can automatically generate a clover report file with every PHPUnit run by adding the following configuration to your phpunit.xml file:
You can automatically generate a clover report file with every PHPUnit run by adding specific configuration to your phpunit.xml file. For PHPUnit v9 use something like following:
```xml
<coverage cacheDirectory=".phpunit.cache/code-coverage" processUncoveredFiles="true">
<include>
<directory suffix=".php">src</directory>
</include>
<report>
<clover outputFile="clover.xml" />
</report>
</coverage>
```
<coverage cacheDirectory=".phpunit.cache/code-coverage" processUncoveredFiles="true">
<include>
<directory suffix=".php">src</directory>
</include>
<report>
<clover outputFile="clover.xml" />
</report>
</coverage>
Since PHPUnit v10.1 file and folder filtering must be declared with a `source` element:
```xml
<coverage includeUncoveredFiles="true">
<report>
<clover outputFile="clover.xml" />
</report>
</coverage>
<source>
<include>
<directory suffix=".php">src</directory>
</include>
</source>
```

# Recommended configuration
Expand Down