Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 2a1e4bc

Browse files
committed
Feature documentation - Issue #496
1 parent 8fbd563 commit 2a1e4bc

File tree

8 files changed

+45
-12
lines changed

8 files changed

+45
-12
lines changed

README.md

Lines changed: 45 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,13 @@
88

99

1010
This Jenkins plugin integrates and publishes multiple coverage report types.
11-
It has been developed during [GSoC 2018](https://jenkins.io/projects/gsoc/2018/code-coverage-api-plugin/).
11+
It has been developed since [GSoC 2018](https://jenkins.io/projects/gsoc/2018/code-coverage-api-plugin/).
12+
13+
* [Supported coverage formats](#Supported-Coverage-Formats)
14+
* [Release notes](#Release-Notes)
15+
* [Features](#Features)
16+
* [Usage](#Usage)
1217

13-
## Features
14-
* Pipeline support
15-
* Modernized coverage chart
16-
* Coverage trend
17-
* Source code navigation
18-
* Parallel execution in pipeline support
19-
* Reports combining
20-
* REST API
21-
* Failed conditions and flexible threshold setting
22-
* Other small features
2318

2419
## Supported Coverage Formats
2520
#### Embedded
@@ -34,7 +29,45 @@ It has been developed during [GSoC 2018](https://jenkins.io/projects/gsoc/2018/c
3429
## Release Notes
3530
See the [GitHub Releases](https://github.com/jenkinsci/code-coverage-api-plugin/releases).
3631

37-
## How to Use it
32+
## Features
33+
### General Features
34+
* Pipeline support
35+
* Parallel execution in pipeline support
36+
* Reports combining
37+
* REST API
38+
* Failed conditions and flexible threshold setting
39+
40+
### Coverage Analysis
41+
* **Coverage analysis of whole projects and pull requests:**
42+
* complete code (Project Coverage)
43+
* code changes (Change Coverage)
44+
* coverage changes created by changed test cases (Indirect Coverage Changes)
45+
* **Modernized coverage report visualization:**
46+
* Coverage overview and trend
47+
48+
![alt text](./images/reportOverview_screen.PNG "Coverage overview and trend")
49+
50+
* Colored project coverage tree map for line and branch coverage
51+
52+
![alt text](./images/reportTree_screen.PNG "Colored project coverage tree map")
53+
54+
* Source code navigation
55+
56+
![alt text](./images/reportFile_screen.PNG "Source code navigation")
57+
58+
* Specific source code view for specifically analyzing the coverage of code changes (Change Coverage):
59+
60+
![alt text](./images/reportCC_screen.PNG "Specific source code view for Change Coverage")
61+
62+
* Specific source code view for specifically analyzing the coverage after test changes (Indirect Coverage Changes):
63+
64+
![alt text](./images/reportICC_screen.PNG "Specific source code view for Indirect Coverage Changes")
65+
66+
* **Customizable coverage overview for the Jenkins dashboard view and for build results:**
67+
![alt text](./images/dashboard_screen.PNG "Analysis overview for Jenkins dashboard")
68+
![alt text](./images/buildview_screen.PNG "Analysis overview for Jenkins build result")
69+
70+
## Usage
3871

3972
### 1. Configure your coverage tool to generate reports
4073

images/buildview_screen.PNG

10.2 KB
Loading

images/dashboard_screen.PNG

9.18 KB
Loading

images/reportCC_screen.PNG

58.4 KB
Loading

images/reportFile_screen.PNG

92.9 KB
Loading

images/reportICC_screen.PNG

76.9 KB
Loading

images/reportOverview_screen.PNG

35.5 KB
Loading

images/reportTree_screen.PNG

39.3 KB
Loading

0 commit comments

Comments
 (0)