Skip to content

Commit 46a5dc8

Browse files
Vishal VaibhavYour Name
authored andcommitted
Readme changes (#32)
* githu org * adding plugin_key for github token Co-authored-by: Your Name <you@example.com>
1 parent 180080d commit 46a5dc8

3 files changed

Lines changed: 10 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11

22
# pull-request-code-coverage
33

4-
[![Build Status](https://vela-server.prod.target.com/badge/TargetOSS/pull-request-code-coverage/status.svg)](https://vela.prod.target.com/TargetOSS/pull-request-code-coverage)
54

6-
[Vela](https://go-vela.github.io/docs/) plugin to allow detecting code coverage for only the lines changed in a PR.
5+
A continuous integration plugin to allow detecting code coverage for only the lines changed in a PR.
76

87
Sometimes when working to get a repo to an acceptable level of code coverage, it can be hard to tell if one change is
98
covered enough. This plugin will look at just the lines changed in the PR and report code coverage for only those
109
lines.
1110

12-
This plugin will output the coverage details to the vela step's console, as well as has the ability to comment on the
13-
PR with a summary of the coverage details.
11+
This plugin will output the coverage details to the CI/CD step's console. A sample [Vela](https://github.com/go-vela) step console
12+
13+
![ ](./images/vela-step-console-pr-code-coverage.png)
14+
15+
16+
This plugin as well as has the ability to comment on the PR with a summary of the coverage details.
17+
![ ](./images/github_pr_coverage.png)
18+
1419

1520
Currently, this plugin supports two coverage file format.
1621
* jacoco for jvm based languages like java,kotlin,scala
1722
* cobertura can be used for golang projects using [gocov-xml](https://github.com/AlekSi/gocov-xml) utility
1823

19-
24+
This plugin works out of box for [Vela](https://github.com/go-vela),a CI/CD open-sourced by target
2025

2126
## VELA Usage
2227

images/github_pr_coverage.png

222 KB
Loading
149 KB
Loading

0 commit comments

Comments
 (0)