mirror of
https://github.com/jstemmer/go-junit-report.git
synced 2025-04-12 08:38:08 -05:00
b61b86b9a7
- Add new section for installing go-junit-report from pre-built binaries. - The instructions for installing from source have been updated to use `go install`, now that `go get` is being deprecated, see #124. - Move contributing guidelines to separate `CONTRIBUTING.md` file.
57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
# go-junit-report
|
|
|
|
go-junit-report is a tool that converts [`go test`] output to an XML report,
|
|
suitable for applications that expect JUnit-style XML reports (e.g.
|
|
[Jenkins](http://jenkins-ci.org)).
|
|
|
|
The test output [parser] and JUnit report [formatter] are also available as Go
|
|
packages.
|
|
|
|
[![Build Status][travis-badge]][travis-link]
|
|
|
|
## Install from package (recommended)
|
|
|
|
Pre-built packages for Windows, macOS and Linux are found on the [Releases]
|
|
page.
|
|
|
|
## Install from source
|
|
|
|
Download and install the latest stable version from source by running:
|
|
|
|
```bash
|
|
go install github.com/jstemmer/go-junit-report@latest
|
|
```
|
|
|
|
## Usage
|
|
|
|
go-junit-report reads the full `go test` output from stdin and writes JUnit
|
|
compatible XML to stdout. In order to capture build errors as well as test
|
|
output, redirect both stdout and stderr to go-junit-report.
|
|
|
|
```bash
|
|
go test -v 2>&1 | go-junit-report > report.xml
|
|
```
|
|
|
|
Parsing benchmark output is also supported, for example:
|
|
|
|
```bash
|
|
go test -v -bench . -count 5 2>&1 | go-junit-report > report.xml
|
|
```
|
|
|
|
If you want go-junit-report to exit with a non-zero exit code when it encounters
|
|
build errors or test failures, set the `-set-exit-code` flag.
|
|
|
|
Run `go-junit-report -help` for a list of all supported flags.
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md].
|
|
|
|
[`go test`]: https://pkg.go.dev/cmd/go#hdr-Test_packages
|
|
[parser]: https://pkg.go.dev/github.com/jstemmer/go-junit-report/parser
|
|
[formatter]: https://pkg.go.dev/github.com/jstemmer/go-junit-report/formatter
|
|
[travis-badge]: https://travis-ci.org/jstemmer/go-junit-report.svg?branch=master
|
|
[travis-link]: https://travis-ci.org/jstemmer/go-junit-report
|
|
[Releases]: https://github.com/jstemmer/go-junit-report/releases
|
|
[CONTRIBUTING.md]: https://github.com/jstemmer/go-junit-report/blob/master/CONTRIBUTING.md
|