webcraftmedia/coverage-check-action
Archived
2
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

update README with github token instructions

Browse Source
This commit is contained in:
Miguel Savignano 2020-12-21 22:12:53 +01:00
parent 4a754f8957
commit 0bc53bbf5c
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -2,6 +2,9 @@
A GitHub Action that check minimum coverage percentage! 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 ### Usage
#### Lcov #### Lcov
@ -12,7 +15,7 @@ A GitHub Action that check minimum coverage percentage!
type: lcov type: lcov
result_path: coverage/example.lcov result_path: coverage/example.lcov
min_coverage: 90 min_coverage: 90
token: ${{secrets.GITHUB_TOKEN}} token: ${{ github.token }}
``` ```
#### [Simplecov](https://github.com/colszowka/simplecov) #### [Simplecov](https://github.com/colszowka/simplecov)
@ -23,7 +26,7 @@ A GitHub Action that check minimum coverage percentage!
type: simplecov type: simplecov
result_path: coverage/.last_run.json result_path: coverage/.last_run.json
min_coverage: 90 min_coverage: 90
token: ${{secrets.GITHUB_TOKEN}} token: ${{ github.token }}
``` ```
## Screenshots ## Screenshots