Skip to content

Commit

Permalink
chore: Add documentation for setting repo permissions (#769)
Browse files Browse the repository at this point in the history
  • Loading branch information
myyk authored May 3, 2023
1 parent 9ea6fdb commit d66f65c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
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

0 comments on commit d66f65c

Please sign in to comment.