Add self-contained gometalinter build tooling.
This commit is contained in:
147
tools/vendor/github.com/mattn/goveralls/README.md
generated
vendored
Normal file
147
tools/vendor/github.com/mattn/goveralls/README.md
generated
vendored
Normal file
@@ -0,0 +1,147 @@
|
||||
goveralls
|
||||
=========
|
||||
|
||||
[Go](http://golang.org) integration for [Coveralls.io](http://coveralls.io)
|
||||
continuous code coverage tracking system.
|
||||
|
||||
# Installation
|
||||
|
||||
`goveralls` requires a working Go installation (Go-1.2 or higher).
|
||||
|
||||
```bash
|
||||
$ go get github.com/mattn/goveralls
|
||||
```
|
||||
|
||||
|
||||
# Usage
|
||||
|
||||
First you will need an API token. It is found at the bottom of your
|
||||
repository's page when you are logged in to Coveralls.io. Each repo has its
|
||||
own token.
|
||||
|
||||
```bash
|
||||
$ cd $GOPATH/src/github.com/yourusername/yourpackage
|
||||
$ goveralls -repotoken your_repos_coveralls_token
|
||||
```
|
||||
|
||||
You can set the environment variable `$COVERALLS_TOKEN` to your token so you do
|
||||
not have to specify it at each invocation.
|
||||
|
||||
# Continuous Integration
|
||||
|
||||
There is no need to run `go test` separately, as `goveralls` runs the entire
|
||||
test suite.
|
||||
|
||||
## Travis CI
|
||||
|
||||
### GitHub Integration
|
||||
|
||||
Enable Travis-CI on your github repository settings.
|
||||
|
||||
For a **public** github repository put below's `.travis.yml`.
|
||||
|
||||
```
|
||||
language: go
|
||||
sudo: false
|
||||
go:
|
||||
- tip
|
||||
before_install:
|
||||
- go get github.com/mattn/goveralls
|
||||
script:
|
||||
- $HOME/gopath/bin/goveralls -service=travis-ci
|
||||
```
|
||||
|
||||
For a **public** github repository, it is not necessary to define your repository key (`COVERALLS_TOKEN`).
|
||||
|
||||
For a **private** github repository put below's `.travis.yml`. If you use **travis pro**, you need to specify `-service=travis-pro` instead of `-service=travis-ci`.
|
||||
|
||||
```
|
||||
language: go
|
||||
sudo: false
|
||||
go:
|
||||
- tip
|
||||
before_install:
|
||||
- go get github.com/mattn/goveralls
|
||||
script:
|
||||
- $HOME/gopath/bin/goveralls -service=travis-pro
|
||||
```
|
||||
|
||||
Store your Coveralls API token in `Environment variables`.
|
||||
|
||||
```
|
||||
COVERALLS_TOKEN = your_token_goes_here
|
||||
```
|
||||
|
||||
or you can store token using [travis encryption keys](https://docs.travis-ci.com/user/encryption-keys/). Note that this is the token provided in the page for that specific repository on Coveralls. This is *not* one that was created from the "Personal API Tokens" area under your Coveralls account settings.
|
||||
|
||||
```
|
||||
$ gem install travis
|
||||
$ travis encrypt COVERALLS_TOKEN=your_token_goes_here --add env.global
|
||||
```
|
||||
|
||||
travis will add `env` block as following example:
|
||||
|
||||
```
|
||||
env:
|
||||
global:
|
||||
secure: xxxxxxxxxxxxx
|
||||
```
|
||||
|
||||
### For others:
|
||||
|
||||
```
|
||||
$ go get github.com/mattn/goveralls
|
||||
$ go test -covermode=count -coverprofile=profile.cov
|
||||
$ goveralls -coverprofile=profile.cov -service=travis-ci
|
||||
```
|
||||
|
||||
## Drone.io
|
||||
|
||||
Store your Coveralls API token in `Environment Variables`:
|
||||
|
||||
```
|
||||
COVERALLS_TOKEN=your_token_goes_here
|
||||
```
|
||||
|
||||
Replace the `go test` line in your `Commands` with these lines:
|
||||
|
||||
```
|
||||
$ go get github.com/mattn/goveralls
|
||||
$ goveralls -service drone.io
|
||||
```
|
||||
|
||||
`goveralls` automatically use the environment variable `COVERALLS_TOKEN` as the
|
||||
default value for `-repotoken`.
|
||||
|
||||
You can use the `-v` flag to see verbose output from the test suite:
|
||||
|
||||
```
|
||||
$ goveralls -v -service drone.io
|
||||
```
|
||||
|
||||
## CircleCI
|
||||
|
||||
Store your Coveralls API token as an [Environment Variable](https://circleci.com/docs/environment-variables).
|
||||
|
||||
In your `circle.yml` add the following commands under the `test` section.
|
||||
|
||||
```yml
|
||||
test:
|
||||
pre:
|
||||
- go get github.com/mattn/goveralls
|
||||
override:
|
||||
- go test -v -cover -race -coverprofile=/home/ubuntu/coverage.out
|
||||
post:
|
||||
- /home/ubuntu/.go_workspace/bin/goveralls -coverprofile=/home/ubuntu/coverage.out -service=circle-ci -repotoken=$COVERALLS_TOKEN
|
||||
```
|
||||
|
||||
For more information, See https://coveralls.zendesk.com/hc/en-us/articles/201342809-Go
|
||||
|
||||
# Authors
|
||||
|
||||
* Yasuhiro Matsumoto (a.k.a. mattn)
|
||||
* haya14busa
|
||||
|
||||
# License
|
||||
|
||||
under the MIT License: http://mattn.mit-license.org/2016
|
||||
Reference in New Issue
Block a user