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 7, 2018
commit da60497d8611e7b2424b2cd4e01a2fccd7edb057
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -11,7 +11,20 @@ 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).

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

- `before-build` - notifies the test reporter of a pending test report

- `after-build` - combines format-coverage and upload-coverage

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

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

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


The subcommands accept the following flags:


Flags for `format-coverage`: