Skip to content

Commit ec80ffb

Browse files
authored
Update README.md (#309)
1 parent 55c5634 commit ec80ffb

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ For more information on these inputs, see the [Workflow syntax for GitHub Action
1515
- `coverage-files`: The coverage files to scan. For example, `coverage/lcov.*.info`
1616
- `artifact-name`: The GitHub artifact name of the generated HTML report. For example, `code-coverage-report`. _Note:_ When downloading, it will be extracted in an `html` directory. Optional. Default: `` (Skips uploading of artifacts)
1717
- `minimum-coverage`: The minimum coverage to pass the check. Optional. Default: `0` (always passes)
18-
- `github-token`: Set the `${{ secrets.GITHUB_TOKEN }}` token to have the action comment the coverage summary in the pull request. This token is provided by Actions, you do not need to create your own token. Optional. Default: ``
18+
- `github-token`: Set the `${{ secrets.GITHUB_TOKEN }}` token to have the action comment the coverage summary in the pull request. This token is provided by Actions (after setting permissions - see sample workflow below), you do not need to create your own token. Optional. Default: ``
1919
- `working-directory`: The working directory containing the source files referenced in the LCOV files. Optional. Default: `./`
2020
- `title-prefix`: A prefix before the title "LCOV of commit...". Optional. Default: ``
2121
- `additional-message`: Custom text appended to the code coverage comment in the pull request. Optional. Default: ``
@@ -39,6 +39,8 @@ jobs:
3939
name: Generate coverage report
4040
needs: testing
4141
runs-on: ubuntu-latest
42+
permissions:
43+
pull-requests: write
4244
steps:
4345
- name: Checkout code
4446
uses: actions/checkout@v2

0 commit comments

Comments
 (0)