The GitHub App
Kuppit reaches your repository through one GitHub App, which you install on the repositories you want to deploy. The same app signs you in. Nothing else, no deploy key, no personal token, is used.
Permissions
| Permission | Access | Used for |
|---|---|---|
| Contents | Read-only | Reading the branch to analyse it and to build it. |
| Checks | Read and write | The Kuppit Preview check on a pull request. Without it previews still deploy; only the check is missing. |
| Metadata | Read-only | Granted automatically with any other permission. Listing the repositories you granted. |
Kuppit never writes to your repository: no commits, no branches, no files, no comments on pull requests.
Events
| Event | What Kuppit does with it |
|---|---|
| Push | Deploys the environment that tracks the pushed branch: Production for the production branch, a named environment for its branch. Pushes to other branches are recorded and ignored. |
| Pull request | Opened or reopened creates a preview; a push to it redeploys the preview; closed removes it. Without this event no preview is ever created. |
Kuppit learns about your repository from these deliveries only. A pull request closed while the app was uninstalled is not discovered later.
Scope
You choose the repositories at installation, one or all, and can widen or narrow the grant later from GitHub's application settings. Kuppit only ever sees what is granted, and a project on a repository you later remove from the grant can no longer deploy.
Pull requests from forks never get a preview, whatever the permissions.