8000 Update README · codecov/example-scala@ff2b9c3 · GitHub
[go: up one dir, main page]
Skip to content

Commit ff2b9c3

Browse files
thomasrockhuthomasrockhu
committed
Update README
1 parent 4b15ef8 commit ff2b9c3

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

‎README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,28 @@
1-
Codecov Scala Example
2-
=====================
1+
# [Codecov](https://codecov.io) Scala Example
2+
3+
## Guide
4+
5+
### Travis Setup
6+
7+
Add to your `.travis.yml` file.
8+
```yml
9+
language: scala
10+
after_success:
11+
- bash <(curl -s https://codecov.io/bash)
12+
```
13+
14+
### Produce Coverage Reports
315
416
1. Add `scoverage` to plugin list
517
- `addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.1")` as [seen here](https://github.com/codecov/example-scala/blob/master/project/plugins.sbt#L1)
618
1. Add `coverage` and `coverageReport` to `sbt`
719
- `sbt clean coverage test coverageReport` as [seen here](https://github.com/codecov/example-scala/blob/master/.travis.yml#L7)
8-
1. After tests are complete add the Codecov uploader
9-
- `bash <(curl -s https://codecov.io/bash)` as [seen here](https://github.com/codecov/example-scala/blob/master/.travis.yml#L10)
10-
- Please provide your upload token. Learn more [here](http://docs.codecov.io/docs/about-the-codecov-bash-uploader#section-upload-token)
1120

12-
We are happy to help if you have any questions. Please contact email our Support at [support@codecov.io](mailto:support@codecov.io)
21+
## Caveats
22+
### Private Repo
23+
Repository tokens are required for (a) all private repos, (b) public repos not using Travis-CI, CircleCI or AppVeyor. Find your repository token at Codecov and provide via appending `-t <your upload token>` to you where you upload reports.
1324

14-
[1]: https://codecov.io/
15-
[2]: https://twitter.com/codecov
16-
[3]: mailto:hello@codecov.io
17-
[4]: https://github.com/codecov/codecov-bash
25+
## Links
26+
- [Community Boards](https://community.codecov.io)
27+
- [Support](https://codecov.io/support)
28+
- [Documentation](https://docs.codecov.io)

0 commit comments

Comments
 (0)
0