The GitHub App
What the ourfault GitHub App is allowed to do in your repositories, and what it does not do with that.
Permissions
You choose which repositories the App can reach when you install it, and you can remove it at any time from your GitHub settings. It asks for these permissions and no others.
| Permission | Access | What it does | What it never does |
|---|---|---|---|
| Metadata | Read | Lists the repositories the installation can reach, so a service can be mapped to one. | Read anything else through it. GitHub grants this permission to every App. |
| Contents | Read and write | Reads the files a failure points at and the repository tree, and writes a branch of its own holding a proposed fix or a setup change. | Commit to your default branch, merge, or touch a branch it did not create. |
| Deployments | Read | Reads recent deployments to see which change shipped before a failure, and when a fix reached production. | Create or change a deployment. |
| Issues | Read and write | Files an issue for a failure, comments on it, labels it, and answers the commands written in its comments. | Edit or close issues it did not file. |
| Pull requests | Read and write | Opens a draft pull request for a proposed fix or a setup change, and reads the files a pull request changes. | Merge, approve, mark a draft ready for review, or push to someone else's branch. |
| Checks | Read and write | Reports on a pull request whether its change touches a failure that is still open. | Block a merge by itself. The check only informs, unless you make it required. |
Contents, Pull requests and Checks are used only once a workspace turns on proposed fixes or pull request checks. An installation that has not accepted them keeps those features off.
Webhook events
-
Issues
An issue ourfault filed changes state, so the ledger follows it.
-
Issue comments
A command is written in an issue.
-
Deployment status
A deployment succeeds, which starts the watch that proves a fix.
-
Push
A push lands on the default branch of a repository that records no deployments, which starts the same watch.
-
Pull requests
A pull request opens, changes, closes or merges, so its check can run and a draft can be followed.
GitHub also sends installation and repository changes to every App without a subscription. Each delivery is checked against its signature before anything reads it, and the content of a delivery is not kept.
The record
The permissions and events above are the ones in the App's manifest, kept in the repository as docs/github-app.json, and this page is checked against it. What ourfault keeps of the data it reads is in the data retention policy.