Added README
This commit is contained in:
parent
3f7018096e
commit
d5ec4bdf1b
1 changed files with 28 additions and 0 deletions
28
README.md
Executable file
28
README.md
Executable file
|
@ -0,0 +1,28 @@
|
||||||
|
# [Bld](https://rife2.com/bld) Extension to Code Coverage Analysis with [JaCoCo](https://www.eclemma.org/jacoco/)
|
||||||
|
|
||||||
|
|
||||||
|
[](http://opensource.org/licenses/BSD-3-Clause)
|
||||||
|
[](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
|
||||||
|
[](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-jacoco-report)
|
||||||
|
[](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-jacoco-report)
|
||||||
|
[](https://github.com/rife2/bld-jacoco-report/actions/workflows/bld.yml)
|
||||||
|
|
||||||
|
To run the tests and generate the code coverage reports:
|
||||||
|
|
||||||
|
```java
|
||||||
|
@BuildCommand(summary = "Generates Jacoco Reports")
|
||||||
|
public void jacoco() throws IOException {
|
||||||
|
new JacocoReportOperation()
|
||||||
|
.fromProject(this)
|
||||||
|
.execute();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```text
|
||||||
|
./bld compile jacoco
|
||||||
|
```
|
||||||
|
|
||||||
|
- The HTML, CVS and XML reports will be automatically created in the `build/reports/jacoco/test` directory.
|
||||||
|
- The execution coverage data will be automatically recorded in the `build/jacoco/jacoco.exec` file.
|
||||||
|
|
||||||
|
Please check the [JacocoReportOperation documentation](https://rife2.github.io/bld-jacoco-report/rife/bld/extension/JacocoOperation.html#method-summary) for all available configuration options.
|
Loading…
Add table
Add a link
Reference in a new issue