-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
17 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,35 @@ | ||
# Jenkins GitHub Coverage Updater | ||
# GitHub Pull Request Coverage Status Plugin for Jenkins | ||
|
||
[![Build Status](https://travis-ci.org/terma/github-pr-coverage-status.svg?branch=master)](https://travis-ci.org/terma/github-pr-coverage-status) | ||
[![Coverage Status](https://coveralls.io/repos/github/terma/github-pr-coverage-status/badge.svg?branch=master)](https://coveralls.io/github/terma/github-pr-coverage-status?branch=master) | ||
|
||
https://wiki.jenkins-ci.org/display/JENKINS/GitHub+PR+Coverage+Status+Plugin | ||
|
||
|
||
Post code coverage status to GitHub pull request comments. Example: | ||
Parse code coverage report generated by build and post code coverage status comment to GitHub pull request: | ||
![Example](https://raw.githubusercontent.com/terma/jenkins-github-coverage-updater/master/screenshot.png) | ||
|
||
## Prerequisite | ||
|
||
* Plugin could be used only for Build triggered by [GitHub pull request builder plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin) | ||
* Plugin use existent coverage reports. Ensure that you have it in Jenkins build workspace | ||
|
||
## Supported coverage reports | ||
|
||
## Supports coverage reports | ||
* Jacoco ```jacoco.xml``` | ||
* Cobertura ```cobertura.xml``` or ```cobertura-coverage.xml``` | ||
* Clover ```clover.xml``` | ||
|
||
## How to use | ||
|
||
* Install plugin | ||
* Select or create new Jenkins build | ||
* Ensure that build create code coverage report file | ||
* Configure build to be triggered by [GitHub pull request builder plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin) | ||
* Install plugin from Jenkins Plugin Repository | ||
* Or manually | ||
* Goto [releases](https://github.com/terma/jenkins-github-coverage-updater/releases) | ||
* Download latest version of plugin *.hpi* file | ||
* Install to your Jenkins [guide](https://wiki.jenkins-ci.org/display/JENKINS/Plugins) | ||
* Configure plugin | ||
* 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](https://github.com/blog/1509-personal-api-tokens) (or keep blank if anonymous access enabled) | ||
* [Optional] Add *Record Master Coverage* post build step to build which test your master | ||
* Add *Publish coverage to GitHub* post build step to build. It should be triggered by [GitHub pull request builder plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin) | ||
|
||
## Changelog | ||
|
||
### 1.0.8 | ||
|
||
First public release to Jenkins Plugin Repo |