Skip to content

Commit 529e448

Browse files
banesullivanlwasser
authored andcommitted
Add documentation about elevated permissions
1 parent 3cb055a commit 529e448

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Diff for: README.md

+6
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ It should look something like this
5555
You are now setup to process pyOpenSci peer review and contributor metadata
5656
using `pyosMeta`.
5757

58+
## Permissions
59+
60+
Please note that the `scripts/get-sprint-data.py` requires your GitHub token to have elevated permissions, specifically with `project` access.
61+
62+
When running on GitHub Actions, the elevated permissions are handled by the `PROJECTS_READ` secret which is a GitHub Token with `project` access that is available across the pyopensci GitHub organization. We only need these elevated permissions for the `scripts/get-sprint-data.py` script (at this time), and the rest of the scripts use the default `GITHUB_TOKEN` so that they can execute as a part of the CI checks for any pull requests coming from forks.
63+
5864
## Build the website using Nox
5965

6066
You can use `nox` to build the site locally. `Nox` will create an `venv`

0 commit comments

Comments
 (0)