Skip to content

Commit 0756fc6

Browse files
authored
Merge pull request #300 from codacy/doc/improve-running-DOCS-207
doc: Clarify how to run codacy-coverage-reporter
2 parents 067527f + 66c03e5 commit 0756fc6

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/adding-coverage-to-your-repository.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,16 @@ After having coverage reports set up for your repository, you must use Codacy Co
3939
export CODACY_API_BASE_URL=<your Codacy instance URL>
4040
```
4141

42-
1. Run Codacy Coverage Reporter to upload the coverage results to Codacy.
43-
44-
The recommended way to do this is using a self-contained script that automatically downloads and runs the most recent version of Codacy Coverage Reporter:
42+
1. Run Codacy Coverage Reporter **on the root of the locally checked out branch of your Git repository**, specifying the relative path to the coverage report to upload. For example:
4543

4644
```bash
47-
bash <(curl -Ls https://coverage.codacy.com/get.sh) report
45+
bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r report.xml
4846
```
4947

50-
See [alternative ways of running Codacy Coverage Reporter](alternative-ways-of-running-coverage-reporter.md) for other ways of running Codacy Coverage Reporter, such as by installing the binary manually or using a CircleCI Orb or GitHub Action.
48+
!!! tip
49+
The recommended self-contained script automatically downloads and runs the most recent version of Codacy Coverage Reporter.
50+
51+
See [alternative ways of running Codacy Coverage Reporter](alternative-ways-of-running-coverage-reporter.md) for other ways of running Codacy Coverage Reporter, such as by installing the binary manually or using a GitHub Action or CircleCI Orb.
5152

5253
1. Optionally, [add a Codacy badge](https://docs.codacy.com/repositories/badges/) to the README of your repository to display the current code coverage.
5354

0 commit comments

Comments
 (0)