Skip to content

Commit 0bc53bb

Browse files
update README with github token instructions
1 parent 4a754f8 commit 0bc53bb

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
A GitHub Action that check minimum coverage percentage!
44

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

710
#### Lcov
@@ -12,7 +15,7 @@ A GitHub Action that check minimum coverage percentage!
1215
type: lcov
1316
result_path: coverage/example.lcov
1417
min_coverage: 90
15-
token: ${{secrets.GITHUB_TOKEN}}
18+
token: ${{ github.token }}
1619
```
1720
1821
#### [Simplecov](https://github.com/colszowka/simplecov)
@@ -23,7 +26,7 @@ A GitHub Action that check minimum coverage percentage!
2326
type: simplecov
2427
result_path: coverage/.last_run.json
2528
min_coverage: 90
26-
token: ${{secrets.GITHUB_TOKEN}}
29+
token: ${{ github.token }}
2730
```
2831
2932
## Screenshots

0 commit comments

Comments
 (0)