search

codeclimate / ruby-test-reporter

DEPRECATED Uploads Ruby test coverage data to Code Climate
https://codeclimate.com
Other
92 stars 92 forks source link

Add execution example and mention optional env #173

Closed ABaldwinHunter closed 7 years ago

ABaldwinHunter commented 7 years ago

Thought this usage section would be useful to have. We don't mention the env var anywhere in README or our docs.

maxjacobson commented 7 years ago

We used to have more details like this, but moved it into our centralized docs: https://github.com/codeclimate/ruby-test-reporter/commit/59b46689507ad95672ad8a3be10506e9f3fc4ac5

We could keep these details in the README as well, we just have to be conscientious about keeping everything up-to-date, which is easier when things are centralized on the docs. WDYT?

ABaldwinHunter commented 7 years ago

we just have to be conscientious about keeping everything up-to-date, which is easier when things are centralized on the docs. WDYT?

I think the invocation and env vars have a low enough churn that having that info in readme wouldn't hurt - and follows the strategy of a lot of other open source tools.

I also believe we don't have mention of the CODECLIMATE_API_HOST in the docs, though I imagine that's less frequently used.

Agree that moving info out of the README seems like a conscious decision though - just wanted to revisit!

maxjacobson commented 7 years ago

@ABaldwinHunter ping

dblandin commented 7 years ago

CODECLIMATE_API_HOST is mentioned in the Code Climate: Enterprise docs: https://docs.codeclimate.com/docs/enterprise-setting-up-test-coverage