Skip to content

Commit 59d488c

Browse files
committed
updated README.md
1 parent 7ee25b3 commit 59d488c

1 file changed

Lines changed: 37 additions & 32 deletions

File tree

README.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
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

3+
# [Codecov][0] Java Example
4+
## Guide
5+
### Travis Setup
146

15-
# Frequently Asked Questions
16-
17-
#### ❔How do I enable multi-module projects?
7+
Add the following to your `travis.yml`:
8+
```yml
9+
language:
10+
LANG_FOR_REPO
11+
after_success:
12+
- bash <(curl -s https://codecov.io/bash)
13+
```
14+
### Produce Coverage Reports
15+
1. Add JaCoCo Plugin to your pom.xml file, [see here](https://github.com/codecov/example-java/blob/master/pom.xml#L38-L56)
16+
## Caveats
17+
#### Private Repo
18+
You will need to add the following your `travis.yml`:
19+
```yml
20+
env:
21+
global:
22+
- CODECOV_TOKEN=:uuid-repo-token
23+
```
24+
We can add more caveats for the language/framework(s) here
1825

19-
In your `pom.xml` file please append a list of modules in your projects
26+
## Support
2027

28+
### FAQ
29+
- Q: How do I enable multi-module projects?<br/>A: In your `pom.xml` file please append a list of modules in your projects:
2130
```xml
2231
<project>
2332
<modules>
@@ -26,23 +35,19 @@ In your `pom.xml` file please append a list of modules in your projects
2635
</modules>
2736
</project>
2837
```
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-
38+
- 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).
39+
- We should talk about using other CIs here.
40+
- 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].
41+
- Q: Is there a Gradle example?<br/>A: **Yes**, enter [codecov/example-gradle][2]
42+
- Q: Is there a Andorid example?<br/>A: **Yes**, enter [codecov/example-android][3]
43+
44+
### Contact
45+
- Intercom (in-app messanger)
46+
47+
- Slack: slack.codecov.io
48+
- [gh/codecov/support](https://github.com/codecov/support)
49+
50+
View source and learn more about [Codecov Global Uploader](https://github.com/codecov/codecov-bash)
4651

4752

4853
[0]: https://codecov.io/

0 commit comments

Comments
 (0)