Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add some details and defaults around the token #316

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,8 @@ jobs:
| `passIcon` | ✅ | the indicator to use for files that passed | 🟢 |
| `failIcon` | ✅ | the indicator to use for files that failed | 🔴 |
| `sourceDir` | ✅ | the indicator to use for files that failed | ./path/to/src |

## Token Permissions

If you adjust the permissions in your workflows, the token that is supplied must have the
pull-request:write permission to be able to comment on the PR.
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ inputs:
required: true
description: 'local path to a coverage xml file like the output of pytest --cov'
token:
required: true
description: 'github token'
description: 'GitHub Token that must have pull-request:write permission'
default: ${{ github.token }}
thresholdAll:
required: false
description: the coverage threshold for average over all files [0,1]
Expand Down
Loading