https://github.com/jjlharrison/coverage-maven-plugin

Maven plugin for calculating test coverage of new changes when compared to another Git branch.
https://github.com/jjlharrison/coverage-maven-plugin

coverage git jacoco java maven maven-plugin

Last synced: 2 days ago
JSON representation

Maven plugin for calculating test coverage of new changes when compared to another Git branch.

• Host: GitHub
• URL: https://github.com/jjlharrison/coverage-maven-plugin
• Owner: jjlharrison
• License: mit
• Created: 2019-09-03T21:46:23.000Z (about 5 years ago)
• Default Branch: develop
• Last Pushed: 2022-09-01T23:12:17.000Z (about 2 years ago)
• Last Synced: 2023-07-01T09:35:50.707Z (over 1 year ago)
• Topics: coverage, git, jacoco, java, maven, maven-plugin
• Language: Java
• Homepage:
• Size: 158 KB
• Stars: 5
• Watchers: 5
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Coverage Maven Plugin

## Usage

    

    

        com.jjlharrison

        coverage-maven-plugin

        {{VERSION}}

        

            develop 

            ${project.reporting.outputDirectory}/jacoco/jacoco.xml

            false 

            ${project.reporting.outputDirectory}/change-coverage/report.xml

            92 

            92 

        

        

            

                post-site 

                

                    report

                    check

                

            

        

    

## Goals

### Report

The `report` goal will diff the current HEAD of the Git repository with a configured branch ("develop" by default) and check the JaCoCo report to determine what line and branch coverage is for changed and new lines.

The `jacoco:report` goal must have been executed before the `coverage:report` goal is executed. 

If the `compareBranch` is behind a remote tracking branch, the plugin will compare with that instead.

If the `compareBranch` is not found, but a remote branch with that name exists, the plugin will compare with that instead.

### Check

The `check` goal will read the change coverage report and will fail the build if the coverage levels fall below the requirements configured.

The `report` goal must have been executed before this goal is executed.

## JDK Support

This project aims to support JDK 1.8 and above. If any issues are found with a particular JDK version, please create a new issue or submit a pull request.