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.

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

add list of subcommands to README.md #374

Open
wants to merge 27 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update README.md
  • Loading branch information
davehenton authored Nov 12, 2018
commit a6861050b88d585f3644ddff726d5acc8ad85688
54 changes: 32 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -2,8 +2,6 @@

# Code Climate Test Reporter

## Overview

Code Climate's test reporter is a binary that works in coordination with codeclimate.com to report test coverage data. Once you've set up test coverage reporting you can:
* view test coverage reports for each file alongside quality metrics like complexity, duplication, and churn,
* toggle between viewing code issues and test coverage line-by-line in the same source listings,
@@ -13,47 +11,59 @@ Code Climate accepts test coverage data from virtually any location, including l

For installation instructions, check out our docs on [Configuring Test Coverage](https://docs.codeclimate.com/docs/configuring-test-coverage) and [Test Coverage Troubleshooting Tips](https://docs.codeclimate.com/docs/test-coverage-troubleshooting-tips).


## Subcommands
Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands):

---

**`format-coverage`** - formats test report from local test suite into generalized format, readable by Code Climate

- `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover* - Identifies the input type (format) of the COVERAGE_FILE

- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json.

- `-p PATH` or `--prefix PATH` - The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory.

- `COVERAGE_FILE` - Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found.
#### `format-coverage`
Formats test report from local test suite into generalized format, readable by Code Climate

- `-t` or `--input-type` *simplecov | lcov | coverage.py | gcov | clover*
- Identifies the input type (format) of the COVERAGE_FILE

- `-o PATH` or `--output PATH` - Output to PATH.
- If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json.

**`sum-coverage`** - combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate
- `-p PATH` or `--prefix PATH`
- The prefix to remove from absolute paths in coverage payloads, to make them relative to the project root. This is usually the directory in which the tests were run. Defaults to current working directory.

- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout. Defaults to coverage/codeclimate.json.
- `COVERAGE_FILE`
- Path to the coverage file to process. Defaults to searching known paths where coverage files could exist and selecting the first one found.

- `-p NUMBER` or `--parts NUMBER` - Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results.
---

#### `sum-coverage`
Combines test reports from multiple sources (i.e. multiple test suites or parallelized CI builds) into one test report which is readable by Code Climate

- `-o PATH` or `--output PATH` - Output to PATH. If - is given, content will be written to stdout.
- Defaults to coverage/codeclimate.json.

- `-p NUMBER` or `--parts NUMBER`
- Expect NUMBER payloads to sum. If this many arguments are not present, command will error. This ensures you don't accidentally sum incomplete results.


---

**`upload-coverage`** - uploads formatted, singular test report to Code Climate API

- `-i PATH` or `--input PATH` - Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json.
#### `upload-coverage`
Uploads formatted, singular test report to Code Climate API

- `-r ID` or `--id ID` - The reporter identifier to use when reporting coverage information. The appropriate value can be found in your Repository Settings page on codeclimate.com. Defaults to the value in the `CC_TEST_REPORTER_ID` environment variable. The uploader will error if a value is not found.
- `-i PATH` or `--input PATH`
- Read payload from PATH. If - is given, the payload will be read from stdin. Defaults to coverage/codeclimate.json.

- `-e URL` or `--endpoint URL` - The endpoint to upload coverage information to. Defaults to the value in the CC_TEST_REPORTER_COVERAGE_ENDPOINT environment variable, or a hard-coded default (currently "https://codeclimate.com/test_reports").
- `-r ID` or `--id ID`
- The reporter identifier to use when reporting coverage information. The appropriate value can be found in your Repository Settings page on codeclimate.com. Defaults to the value in the `CC_TEST_REPORTER_ID` environment variable. The uploader will error if a value is not found.

- `-e URL` or `--endpoint URL`
- The endpoint to upload coverage information to. Defaults to the value in the CC_TEST_REPORTER_COVERAGE_ENDPOINT environment variable, or a hard-coded default (currently "https://codeclimate.com/test_reports").

---

**`after-build`** - combines `format-coverage` and `upload-coverage`
#### `after-build`
Combines `format-coverage` and `upload-coverage`

- `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process. Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests.
- `--exit-code $EXIT_CODE` - `$EXIT_CODE` should be the exit code of your test suite process.
- Some CI system expose this as an environment variable; for others, you may need to manually capture `$?` to provide it to `after-build` later. Providing this will prevent sending test coverage results for failed tests.


To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing/).