Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 37 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,13 @@


This Jenkins plugin integrates and publishes multiple coverage report types.
It has been developed during [GSoC 2018](https://jenkins.io/projects/gsoc/2018/code-coverage-api-plugin/).
It has been developed since [GSoC 2018](https://jenkins.io/projects/gsoc/2018/code-coverage-api-plugin/).

* [Supported coverage formats](#Supported-Coverage-Formats)
* [Release notes](#Release-Notes)
* [Features](#Features)
* [Usage](#Usage)

## Features
* Pipeline support
* Modernized coverage chart
* Coverage trend
* Source code navigation
* Parallel execution in pipeline support
* Reports combining
* REST API
* Failed conditions and flexible threshold setting
* Other small features

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

## How to Use it
## Features
* **Coverage analysis of whole projects and pull requests:**
* complete code (Project Coverage)
* code changes (Change Coverage)
* coverage changes created by changed test cases (Indirect Coverage Changes)
* **Modernized coverage report visualization:**
* Coverage overview and trend

![alt text](./images/reportOverview_screen.PNG "Coverage overview and trend")

* Colored project coverage tree map for line and branch coverage

![alt text](./images/reportTree_screen.PNG "Colored project coverage tree map")

* Source code navigation

![alt text](./images/reportFile_screen.PNG "Source code navigation")

* Specific source code view for specifically analyzing the coverage of code changes (Change Coverage):

![alt text](./images/reportCC_screen.PNG "Specific source code view for Change Coverage")

* Specific source code view for specifically analyzing the coverage after test changes (Indirect Coverage Changes):

![alt text](./images/reportICC_screen.PNG "Specific source code view for Indirect Coverage Changes")

* **Customizable coverage overview for the Jenkins dashboard view and for build results:**
![alt text](./images/dashboard_screen.PNG "Analysis overview for Jenkins dashboard")
![alt text](./images/buildview_screen.PNG "Analysis overview for Jenkins build result")

## Usage

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

Expand Down
Binary file added images/buildview_screen.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboard_screen.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/reportCC_screen.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/reportFile_screen.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/reportICC_screen.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/reportOverview_screen.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/reportTree_screen.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.