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.

Sign up for GitHub

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

doc: minimal permissions of GitHub token #107

Merged
merged 1 commit into from
Jan 19, 2024
Merged

doc: minimal permissions of GitHub token #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
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
Loading