Skip to content

Commit

Permalink
docs: add section on why certain permissions are needed
Browse files Browse the repository at this point in the history
  • Loading branch information
justinawrey committed Oct 7, 2022
1 parent 175fefe commit f45328e
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,15 @@ In order to be able to authenticate with Github, you must set an environment
variable called `GITHUB_TOKEN` to a
[personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
with `repo` permissions.

## Granting permissions

`shipit` requires environment, network, and subprocess creation permissions:

- `--allow-env`: `shipit` reads `GITHUB_TOKEN` from your local environment in
order to authenticate with Github
- `--allow-run`: `shipit` needs to spawn subprocesses (`git`, `bash`) in order
to gather information about your commits

- `--allow-net`: `shipit` needs to make outbound networks requests to Github in
order to create Github releases

0 comments on commit f45328e

Please sign in to comment.