Skip to content

Commit

Permalink
update README with github token instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
MiguelSavignano committed Dec 21, 2020
1 parent 4a754f8 commit 0bc53bb
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

A GitHub Action that check minimum coverage percentage!

This action requires a Github token with `checks:write` scope to allow create the check run using the Github API v3.
But no need to generate any new token, you can use the Github action token (`${{ github.token }}`)

### Usage

#### Lcov
Expand All @@ -12,7 +15,7 @@ A GitHub Action that check minimum coverage percentage!
type: lcov
result_path: coverage/example.lcov
min_coverage: 90
token: ${{secrets.GITHUB_TOKEN}}
token: ${{ github.token }}
```
#### [Simplecov](https://github.com/colszowka/simplecov)
Expand All @@ -23,7 +26,7 @@ A GitHub Action that check minimum coverage percentage!
type: simplecov
result_path: coverage/.last_run.json
min_coverage: 90
token: ${{secrets.GITHUB_TOKEN}}
token: ${{ github.token }}
```
## Screenshots
Expand Down

0 comments on commit 0bc53bb

Please sign in to comment.