Skip to content

Commit 82bbae2

Browse files
authored
add note about token permission [skip ci]
1 parent 6323770 commit 82bbae2

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,13 @@ Which should show a commit status message like:
113113
114114
This script reads the code coverage summary from `coverage/coverage-summary.json` by default (you can specific a different file name using `--from` option) and posts the commit status, always passing for now.
115115

116+
**Note:** to write the commit status, the GitHub token needs "write" permission, so set it in your workflow file:
117+
118+
```yml
119+
permissions:
120+
statuses: write
121+
```
122+
116123
If there is a coverage badge in the README file, you can add 2nd status check. This check will read the code coverage from the README file (by parsing the badge text), then will set a failing status check if the coverage dropped more than 1 percent. **Tip:** use this check on pull requests to ensure tests and code are updated together before merging.
117124

118125
```yaml

0 commit comments

Comments
 (0)