Skip to content

Commit 4029659

Browse files
author
Steve Peak
authored
Merge pull request codecov#16 from TomPed/README-update
Readme update
2 parents 7ee25b3 + 00b68fa commit 4029659

1 file changed

Lines changed: 43 additions & 33 deletions

File tree

README.md

Lines changed: 43 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,34 @@
1-
[Codecov][0] Java Example
2-
=========================
31

4-
1. Add JaCoCo Plugin to your pom.xml file, [see here](https://github.com/codecov/example-java/blob/master/pom.xml#L38-L56)
5-
2. Call `bash <(curl -s https://codecov.io/bash) -t repository-upload-token` at the end of your CI build
6-
- Using Travis CI, CircleCI or AppVeyor **AND** the repository is public? **You're done!** No token needed.
7-
- Otherwise, please add your [repository token token][5].
8-
9-
> Other examples
10-
> - [Maven Example][4]
11-
> - [Gradle Example][2]
12-
> - [Android Example][3]
132

143

15-
# Frequently Asked Questions
4+
# [Codecov][0] Java Example
5+
## Guide
6+
### Travis Setup
167

17-
#### ❔How do I enable multi-module projects?
18-
19-
In your `pom.xml` file please append a list of modules in your projects
8+
Add the following to your `.travis.yml`:
9+
```yml
10+
language:
11+
LANG_FOR_REPO
12+
after_success:
13+
- bash <(curl -s https://codecov.io/bash)
14+
```
15+
### Produce Coverage Reports
16+
1. Add JaCoCo Plugin to your pom.xml file, [see here](https://github.com/codecov/example-java/blob/master/pom.xml#L38-L56)
17+
## Caveats
18+
#### Private Repo
19+
You will need to add the following your `.travis.yml`:
20+
```yml
21+
env:
22+
global:
23+
- CODECOV_TOKEN=:uuid-repo-token
24+
```
25+
#### JaCoCo Reports
26+
- Make sure you are on the most up-to-date JaCoCo version. There are issues with previous versions of JaCoCo.
27+
- JaCoCo reports can expire - Codecov will reject reports that are older than 12 hours. The logs contain details if a report expired.
28+
## Support
2029

30+
### FAQ
31+
- Q: How do I enable multi-module projects?<br/>A: In your `pom.xml` file please append a list of modules in your projects:
2132
```xml
2233
<project>
2334
<modules>
@@ -26,24 +37,23 @@ In your `pom.xml` file please append a list of modules in your projects
2637
</modules>
2738
</project>
2839
```
29-
30-
#### ❔Seeing `Skipping JaCoCo execution due to missing execution data file`?
31-
32-
Please see [http://stackoverflow.com/questions/18107375/...](http://stackoverflow.com/questions/18107375/getting-skipping-jacoco-execution-due-to-missing-execution-data-file-upon-exec)
33-
34-
#### ❔Does Codecov accept `jacoco.exec` reports?
35-
36-
**No**, these files are not supported. Please produce a `xml` file as detailed in the pom.xml file at [codecov/example-java][1]
37-
38-
#### ❔Is there a Gradle example?
39-
40-
**Yes**, enter [codecov/example-gradle][2]
41-
42-
#### ❔Is there a Android example?
43-
44-
**Yes**, enter [codecov/example-android][3]
45-
46-
40+
- Q: Seeing `Skipping JaCoCo execution due to missing execution data file`?<br/>A: Please see [http://stackoverflow.com/questions/18107375/...](http://stackoverflow.com/questions/18107375/getting-skipping-jacoco-execution-due-to-missing-execution-data-file-upon-exec).
41+
- We should talk about using other CIs here.
42+
- Q: Does Codecov accept `jacoco.exec` reports?<br/>A: **No**, these files are not supported. Please produce a `xml` file as detailed in the pom.xml file at [codecov/example-java][1].
43+
- Q: Is there a Gradle example?<br/>A: **Yes**, enter [codecov/example-gradle][2]
44+
- Q: Is there a Andorid example?<br/>A: **Yes**, enter [codecov/example-android][3]
45+
- Q: Is there a Maven example?<br/>A: **Yes**, enter [codecov/example-maven][4]
46+
47+
### Contact
48+
- Intercom (in-app messanger)
49+
50+
- Slack: slack.codecov.io
51+
- [gh/codecov/support](https://github.com/codecov/support)
52+
53+
54+
1. More documentation at https://docs.codecov.io
55+
2. Configure codecov through the `codecov.yml` https://docs.codecov.io/docs/codecov-yaml
56+
3. View source and learn more about [Codecov Global Uploader](https://github.com/codecov/codecov-bash)
4757

4858
[0]: https://codecov.io/
4959
[1]: https://github.com/codecov/example-java

0 commit comments

Comments
 (0)