Skip to content

Commit

Permalink
doc: minimal permissions of GitHub token
Browse files Browse the repository at this point in the history
  • Loading branch information
jamacku authored and zmiklank committed Jan 19, 2024
1 parent 9677571 commit c9dff33
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ See [Testing Farm onboarding guide](https://docs.testing-farm.io/general/0.1/onb

| Input Name | Description | Default value |
|------------|-------------|---------------|
| `github_token` | Github token passed from secrets | `${{ github.token }}` |
| `github_token` | GitHub token passed from secrets | `${{ github.token }}` |
| `create_issue_comment` | If GitHub action will create a github issue comment | false |
| `pull_request_status_name` | GitHub pull request status name | Fedora |
| `debug` | Print debug logs when working with testing farm | true |
Expand All @@ -70,6 +70,19 @@ See [Testing Farm onboarding guide](https://docs.testing-farm.io/general/0.1/onb
| `create_github_summary` | Create summary of the Testing Farm as GiHub Action job. Possible options: "false", "true", "key=value" | true |
| `timeout` | Timeout for the Testing Farm job in minutes. | 480 |

> [!TIP]
>
> Testing Farm as GitHub Action requires a GitHub token with the following permissions:
>
> ```yml
> permissions:
> contents: read
> # This is required for the ability to create Issue comment
> pull-requests: write
> # This is required for the ability to create/update the Pull request status
> statuses: write
> ```
## Example
### Pull request example
Expand Down

0 comments on commit c9dff33

Please sign in to comment.