Skip to content

Commit e993ad5

Browse files
committed
add details about the required permissions to the readme
1 parent f90abc4 commit e993ad5

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,8 @@ The GitHub token to use for creating a PR. If not specified, the action will use
4343
A comma-separated list of filenames to check for the "Tested Up To" version. If not specified, the action will use `readme.txt` and `README.md`.
4444

4545
#### `branch`
46-
The branch to create the PR against. If not specified, the action will use the `main` branch.
46+
The branch to create the PR against. If not specified, the action will use the `main` branch.
47+
48+
## Permissions
49+
50+
The `write` permissions on `contents` and `pull-requests` are important. They are required for the action to commit the changes back to the repository and open a pull request. The only files affected by the action are files named `readme.txt`, `README.md` or those files matching the pattern (looking for "Tested Up To" in the file) that have been specified in the `filenames` input.

0 commit comments

Comments
 (0)