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

chore: Add documentation for setting repo permissions #769

Merged
merged 1 commit into from
May 3, 2023
Merged

chore: Add documentation for setting repo permissions #769

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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@ with the default settings.

## Usage

### Requirement: Repo Settings

This Github action requires the ability to read/write comments on Pull Requests (Issues api).

#### Enable through Settings UI

Under `Settings` > `Actions` > `General` (ex: `/~https://github.com/<org>/<repo>/settings/actions`)

![actions general settings](https://user-images.githubusercontent.com/1266923/235630498-3e920bb8-a9bc-4e4e-bf7d-a4f6d97985f2.png "Settings to change")

#### Enable through Finegrain settings

Follow documentation here: https://docs.github.com/actions/reference/authentication-in-a-workflow#modifying-the-permissions-for-the-github_token

(Please contribute if you've done this)

### Workflow Integration

Create a new workflow in `.github/workflows/` as a new `.yaml` file.
Expand Down