From c228372bbc60cdc259735d894aa2fa571b924529 Mon Sep 17 00:00:00 2001 From: Jan Macku Date: Fri, 19 Jan 2024 12:47:31 +0100 Subject: [PATCH] doc: minimal permissions of GitHub token --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6cf928c..603dbf3 100644 --- a/README.md +++ b/README.md @@ -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 | @@ -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