-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Spruce up documentation with examples.
- Loading branch information
GP
committed
Aug 9, 2019
1 parent
d8c8a2b
commit 5892abf
Showing
1 changed file
with
8 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) |