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 7540607f2931d885c11ab68e9ec68a34eafbbc26
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ To sign up for Code Climate, head [here](https://codeclimate.com/quality/pricing

### Subcommands

Some installations may require the use of the following [subcommands](https://docs.codeclimate.com/docs/configuring-test-coverage#section-list-of-subcommands):
Some installations may require the use of the below subcommands (and their supported flags). For example, here's an example of using the `--prefix` flag under the `after-build` subcommand: `cc-test-reporter after-build --prefix /home/rof/src/github.com/user_or_org_name/repo_name`

#### `format-coverage`
Formats test report from local test suite into generalized format, readable by Code Climate
@@ -68,6 +68,9 @@ 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.

- `-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.