Code coverage icon for GitHub pull requests
- Overview
- Supports coverage reports
- How to use
- How to use with Jenkins Pipelines
- Troubleshooting
- Changelog
Parse code coverage report generated by build and post code coverage status comment to GitHub pull request:
- Jacoco
jacoco.xml - Cobertura
cobertura.xmlorcobertura-coverage.xml - Clover
clover.xml - SimpleCov JSON (Ruby)
coverage.json
- Install plugin from Jenkins Plugin Repository
- Or manually
- Goto
Manage Jenkins|Configure System - Find section
Coverage status for GitHub Pull Requests - Configure global settings of plugin
- GitHub API URL keep blank for GitHub.com and fill if for dedicated instance of GitHub, example:
http(s)://hostname/api/v3/ - Set Personal Access Token (or keep blank if anonymous access enabled)
- GitHub API URL keep blank for GitHub.com and fill if for dedicated instance of GitHub, example:
To be able compare Pull Request coverage plugin needs master coverage for GitHub repository.
- Add Record Master Coverage post build step to build which tests your master. Coverage will be stored per repository URL
You have the option to get the master coverage (base coverage) from your SonarQube instance. Otherwise the plugin will keep track of the master coverage in the project configuration file.
- Goto
Manage Jenkins - Find section
Coverage status for GitHub Pull Requests - Fill
Sonar URLfield - e.g.http://sonar.mycompany.com - Turn On
Use Sonar for master coverage - Optionally use can specify your personal
Sonar access token. - The next pull request build will use SonarQube as the the source for master coverage
The plugin will try to find the project in SonarQube based on the repository name. If more than one projects match, a warning is logged, and the first one will be used to get the coverage data.
Depends on plugin which you are using to run (trigger) pull request in Jenkins.
- To Jenkins Job triggered by GitHub pull request builder plugin add Publish coverage to GitHub post build step
- Ensure that build create code coverage report file
- To Jenkins Job triggered by Branch API Plugin add Publish coverage to GitHub post build step
- Ensure that build create code coverage report file
- Before
Publish coverage to GitHubstep injectCHANGE_IDandCHANGE_URLto build envs where first one is Pull Request ID (number) and second link to repository - Add Publish coverage to GitHub post build step to build
- Ensure that build create code coverage report file
-
After running tests set build result to Success
currentBuild.result = 'SUCCESS'
-
Trigger MasterCoverageAction to collect master coverage (scmVars is needed for multibranch)
step([$class: 'MasterCoverageAction', scmVars: [GIT_URL: env.GIT_URL]])- Optionally you can specify jacoco counter type like this:
step([$class: 'MasterCoverageAction', jacocoCounterType: 'INSTRUCTION', scmVars: [GIT_URL: env.GIT_URL]]) - You can also specify how the result will pe published (comment or status check). By default it will be published as a status check
step([$class: 'MasterCoverageAction', jacocoCounterType: 'INSTRUCTION', publishResultAs: 'statusCheck', scmVars: [GIT_URL: env.GIT_URL]])
-
Trigger CompareCoverageAction to compare coverage and publish results (scmVars is needed for multibranch)
step([$class: 'CompareCoverageAction', scmVars: [GIT_URL: env.GIT_URL]])- Optionally use can specify here jacoco counter type and sonar login and sonar password like this:
step([$class: 'CompareCoverageAction', jacocoCounterType: 'INSTRUCTION', sonarLogin: "login", sonarPassword: "password"]) - You can also specify how the result will pe published (comment or status check). By default it will be published as a status check
step([$class: 'MasterCoverageAction', jacocoCounterType: 'INSTRUCTION', publishResultAs: 'statusCheck', scmVars: [GIT_URL: env.GIT_URL]])
-
Simple Multibranch Pipeline example
pipeline {
agent {
label 'linux'
}
tools {
maven 'maven-3.0.3'
}
stages {
stage('Checkout') {
steps {
checkout scm
}
}
stage('Build and Test') {
steps {
sh 'mvn clean package'
}
}
stage('Record Coverage') {
when { branch 'master' }
steps {
script {
currentBuild.result = 'SUCCESS'
}
step([$class: 'MasterCoverageAction', scmVars: [GIT_URL: env.GIT_URL]])
}
}
stage('PR Coverage to Github') {
when { allOf {not { branch 'master' }; expression { return env.CHANGE_ID != null }} }
steps {
script {
currentBuild.result = 'SUCCESS'
}
step([$class: 'CompareCoverageAction', publishResultAs: 'statusCheck', scmVars: [GIT_URL: env.GIT_URL]])
}
}
}Because of that GitHub can't render icon picture hosted on Jenkins. Plugin can use http://shields.io public resource instead of Jenkins hosted picture. To use it:
- Goto
Jenkins Configuration - Turn on
Jenkins is not accessible for GitHub - Done next coverage comment in Pull Request will use http://shields.io
If you see next picture on your pull request in GitHub:
In most cases that mean that your Jenkins runs on http instead of https
Plugin uses same protocol as your Jenkins, however GitHub in most cases accessible by https
Default browser policy to block non secure resources on secure pages from unknown domain.
To fix that:
- Configure Jenkins to be accessible for
httpshttps://jenkins.io/doc/book/installing/#configuring-http - Next you have a few options:
- Run your Jenkins on
httpsonly - Or configure plugin to publish link on picture over
https- Open Jenkins
- Click
Manage Jenkins - Click
Configure System- Find section
Coverage status for GitHub Pull Requests - Find property
Jenkins URL for icon in Pull Request - Put URL to your Jenkins with
httpslikehttps://jenkins.my.com - Save
- Find section
- Restart Jenkins
- Remove non-UTF-8 symbol from version
- Fail the status check when the coverage decreased
- Non back compatible change minimum Java version 8 (before 7) & Jenkins 2.7 (before 1.5...)
- Github-api lib upgraded to 1.90
- Add params support for freestyle jobs
- Allow publishing result as a status check
- Allow counter type selection for Jacoco
- Update jacoco from 0.7.5.x to 0.8.1
- Use scmVars before env variables for git url detection
- Allow to disable SimpleCov Coverage parser
- Add support of Workflow SCM Step Plugin
- Fix Master showing 0% even after RecordMasterCoverage is run
- Sonar token & login/password authentication
- SimpleCov JSON report fix coverage
- Support of https://github.com/jenkinsci/branch-api-plugin
- Support for Jenkins Pipeline
- Support single quotes for Cobertura Report
- Cobertura plugin ignores zero for
lineRateorbranchRateas resultlineRate=0 branchRate=0.5 => Coverage 25%became0.5aslineRate=0, same policy forbranchRate - Log Enchacements
Supporting Master Coverage from SonarQube. Check (details)[#master-coverage-from-sonar]
Supporting of private Jenkins with public GitHub. To enable that mode goto Jenkins Configuration and turn on Jenkins is not accessible for GitHub
Add support SimpleCov JSON coverage report for Ruby
Add alternative text to coverage image for case when GitHub doesn't able to show image
Correct parsing Cobertura report for edge cases
First public release to Jenkins Plugin Repo
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent