You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17Lines changed: 17 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,10 @@ jobs:
33
33
34
34
# Optional. Whether or not to actually perform the permissions update. Defaults to false.
35
35
dry-run: false
36
+
37
+
# Required. The GitHub token to use for the permissions update.
38
+
# See "github-token" section below for more details.
39
+
github-token: ${{ secrets.GITHUB_TOKEN }}
36
40
```
37
41
38
42
### Parameters
@@ -41,6 +45,19 @@ jobs:
41
45
| --- | --- | --- |
42
46
| `file-path` | The path to the CODEOWNERS file to format. Will auto-detect if not passed in. | `CODEOWNERS` |
43
47
| `dry-run` | Whether or not to actually perform the permissions update. | `false` |
48
+
| `github-token` | The GitHub token to use for the permissions update. | - |
49
+
50
+
#### `github-token`
51
+
52
+
If you are running this action in an org-scoped repository that will be operating on organization teams, you will likely need a personal access token (PAT) with the following scopes:
53
+
54
+
- `repo`: in order to add teams/collaborators to the repository.
55
+
- `read:org`: in order to list organization teams and their permissions on the repository.
56
+
57
+
If you instead are using a GitHub App's [installation token](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-an-installation), you will need to grant the following permissions to the token:
58
+
59
+
- `contents: write`: in order to write teams/collaborators to the repository.
60
+
- `members: read`: in order to list organization teams and their permissions on the repository.
0 commit comments