Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: Clarify how to run codacy-coverage-reporter #300

Merged
merged 1 commit into from Mar 3, 2021
Merged

doc: Clarify how to run codacy-coverage-reporter #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/adding-coverage-to-your-repository.md
View file
Open in desktop
Expand Up @@ -39,15 +39,16 @@ After having coverage reports set up for your repository, you must use Codacy Co
export CODACY_API_BASE_URL=<your Codacy instance URL>
```

1. Run Codacy Coverage Reporter to upload the coverage results to Codacy.

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:
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:

```bash
bash <(curl -Ls https://coverage.codacy.com/get.sh) report
bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r report.xml
```

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.
!!! tip
The recommended self-contained script automatically downloads and runs the most recent version of Codacy Coverage Reporter.

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.

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

Expand Down