diff --git a/README.md b/README.md index 28f0b38fb..9044261f9 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/images/buildview_screen.PNG b/images/buildview_screen.PNG new file mode 100644 index 000000000..7aca1f2ba Binary files /dev/null and b/images/buildview_screen.PNG differ diff --git a/images/dashboard_screen.PNG b/images/dashboard_screen.PNG new file mode 100644 index 000000000..1a93c9df1 Binary files /dev/null and b/images/dashboard_screen.PNG differ diff --git a/images/reportCC_screen.PNG b/images/reportCC_screen.PNG new file mode 100644 index 000000000..a23c872ff Binary files /dev/null and b/images/reportCC_screen.PNG differ diff --git a/images/reportFile_screen.PNG b/images/reportFile_screen.PNG new file mode 100644 index 000000000..d154b2237 Binary files /dev/null and b/images/reportFile_screen.PNG differ diff --git a/images/reportICC_screen.PNG b/images/reportICC_screen.PNG new file mode 100644 index 000000000..418a308c5 Binary files /dev/null and b/images/reportICC_screen.PNG differ diff --git a/images/reportOverview_screen.PNG b/images/reportOverview_screen.PNG new file mode 100644 index 000000000..c12c6223a Binary files /dev/null and b/images/reportOverview_screen.PNG differ diff --git a/images/reportTree_screen.PNG b/images/reportTree_screen.PNG new file mode 100644 index 000000000..1d4e1ea6a Binary files /dev/null and b/images/reportTree_screen.PNG differ