Skip to content

Commit

Permalink
docs: Spruce up documentation with examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
GP committed Aug 9, 2019
1 parent d8c8a2b commit 5892abf
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,22 @@

A GitHub action that sends your code coverage to [Code Climate](http://codeclimate.com/).

ℹ️ For now, it only supports Node.js projects.

# Usage
This action requires that you set [`CC_TEST_REPORTER_ID`](https://docs.codeclimate.com/docs/configuring-test-coverage) environment variable. You can find it under Repo Settings in your Code Climate project.

The default coverage command is `yarn coverage`. You can change it by setting the `args` value.

# Example

<img align="right" height="350" src="/action.png?raw=true">
<img height="891" src="action.png?raw=true">

```
action "send coverage to code climate" {
action "Publish code coverage" {
uses = "paambaati/[email protected]"
env = ["CC_TEST_REPORTER_ID"]
}
```

Example project — [paambaati/websight](https://github.com/paambaati/websight/blob/master/.github/main.workflow)

0 comments on commit 5892abf

Please sign in to comment.