Skip to content

Commit

Permalink
Merge pull request #176 from codacy/wget-docs
Browse files Browse the repository at this point in the history
Update documentation on using with wget on Alpine
  • Loading branch information
lolgab authored Mar 11, 2020
2 parents 7fbca97 + e4d8541 commit e406a72
Showing 1 changed file with 31 additions and 6 deletions.
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,47 @@ Or use the flag: `--codacy-api-base-url <Codacy_instance_URL>:16006`.

## Running Codacy Coverage Reporter

Requirements:
### Requirements

- bash
- curl or wget
- glibc
- `bash` or `sh` (Use `bash` on Ubuntu)
- `curl` or `wget`
- `glibc`

### _Using curl_
```bash
bash <(curl -Ls https://coverage.codacy.com/get.sh)
```

> To specify a coverage reporter version, use `CODACY_REPORTER_VERSION` environment variable. You can find all versions in the [Releases tab](https://github.com/codacy/codacy-coverage-reporter/releases).
### _Using wget_
```bash
bash <(wget -q -O - https://coverage.codacy.com/get.sh)
```

Using CircleCI? Check out the [codacy/coverage-reporter orb](docs/installation.md#circleci-orb).
### _On Alpine Linux_
```sh
wget -qO - https://coverage.codacy.com/get.sh | sh
```

#### _On Alpine Linux passsing command line options_
```sh
wget -qO - https://coverage.codacy.com/get.sh | sh -s report -l Java -r report1.xml --partial
```

### Choose a specific version
The script uses by default the latest version.

If you want to specify a coverage reporter version, use `CODACY_REPORTER_VERSION` environment variable.

You can find all versions in the [Releases tab](https://github.com/codacy/codacy-coverage-reporter/releases).

### Manual Installation

If the automated script does not cover your use case, [check the manual installation methods](docs/installation.md).

## CircleCI Orb

Using CircleCI? Check out the [codacy/coverage-reporter orb](docs/installation.md#circleci-orb).

## Supported formats

The following table contains the formats supported and which coverage tools generate them:
Expand Down

0 comments on commit e406a72

Please sign in to comment.