Add documentation for test coverage report badge
This commit is contained in:
parent
dfd9138929
commit
a0ed41a52f
2 changed files with 37 additions and 10 deletions
|
@ -32,6 +32,41 @@ project.
|
||||||
|
|
||||||
Clicking on a pipeline will show the builds that were run for that pipeline.
|
Clicking on a pipeline will show the builds that were run for that pipeline.
|
||||||
|
|
||||||
|
## Badges
|
||||||
|
|
||||||
|
There are build status and test coverage report badges available.
|
||||||
|
|
||||||
|
Go to pipeline settings to see available badges and code you can use to embed
|
||||||
|
badges in the `README.md` or your website.
|
||||||
|
|
||||||
|
### Build status badge
|
||||||
|
|
||||||
|
You can access a build status badge image using following link:
|
||||||
|
|
||||||
|
```
|
||||||
|
http://example.gitlab.com/namespace/project/badges/branch/build.svg
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test coverage report badge
|
||||||
|
|
||||||
|
GitLab makes it possible to define the regular expression for coverage report,
|
||||||
|
that each build log will be matched against. This means that each build in the
|
||||||
|
pipeline can have the test coverage percentage value defined.
|
||||||
|
|
||||||
|
You can access test coverage badge using following link:
|
||||||
|
|
||||||
|
```
|
||||||
|
http://example.gitlab.com/namespace/project/badges/branch/coverage.svg
|
||||||
|
```
|
||||||
|
|
||||||
|
If you would like to get the coverage report from the specific job, you can add
|
||||||
|
a `job=coverage_job_name` parameter to the URL. For example, it is possible to
|
||||||
|
use following Markdown code to embed the est coverage report into `README.md`:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
![coverage](http://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=coverage)
|
||||||
|
```
|
||||||
|
|
||||||
[builds]: #builds
|
[builds]: #builds
|
||||||
[jobs]: yaml/README.md#jobs
|
[jobs]: yaml/README.md#jobs
|
||||||
[stages]: yaml/README.md#stages
|
[stages]: yaml/README.md#stages
|
||||||
|
|
|
@ -218,21 +218,13 @@ project's settings.
|
||||||
For more information read the
|
For more information read the
|
||||||
[Builds emails service documentation](../../project_services/builds_emails.md).
|
[Builds emails service documentation](../../project_services/builds_emails.md).
|
||||||
|
|
||||||
## Builds badge
|
|
||||||
|
|
||||||
You can access a builds badge image using following link:
|
|
||||||
|
|
||||||
```
|
|
||||||
http://example.gitlab.com/namespace/project/badges/branch/build.svg
|
|
||||||
```
|
|
||||||
|
|
||||||
Awesome! You started using CI in GitLab!
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
Visit the [examples README][examples] to see a list of examples using GitLab
|
Visit the [examples README][examples] to see a list of examples using GitLab
|
||||||
CI with various languages.
|
CI with various languages.
|
||||||
|
|
||||||
|
Awesome! You started using CI in GitLab!
|
||||||
|
|
||||||
[runner-install]: https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/tree/master#install-gitlab-runner
|
[runner-install]: https://gitlab.com/gitlab-org/gitlab-ci-multi-runner/tree/master#install-gitlab-runner
|
||||||
[blog-ci]: https://about.gitlab.com/2015/05/06/why-were-replacing-gitlab-ci-jobs-with-gitlab-ci-dot-yml/
|
[blog-ci]: https://about.gitlab.com/2015/05/06/why-were-replacing-gitlab-ci-jobs-with-gitlab-ci-dot-yml/
|
||||||
[examples]: ../examples/README.md
|
[examples]: ../examples/README.md
|
||||||
|
|
Loading…
Reference in a new issue