Skip to content

docs(github): mirror all app permissions and events to GHE setup #18830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
alexsohn1126 wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs(github): mirror all app permissions and events to GHE setup #18830

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion docs/integrations/source-code-mgmt/github/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,12 @@ Occasionally, Sentry will request additional permissions to your GitHub account

### Register new GitHub App

<Alert>

Because you create and own this GitHub App yourself, you're responsible for keeping its configuration current. The permissions and events below mirror those of the [Sentry GitHub App](#github-permissions) used for `github.com` installations, so that GitHub Enterprise installations support the same features. When Sentry adds a permission or event to the GitHub App, update your GitHub Enterprise App to match, otherwise newer features may not work.

</Alert>

1. First, you'll need to generate a webhook secret. For example, in terminal:

```
Expand Down Expand Up @@ -142,13 +148,29 @@ Occasionally, Sentry will request additional permissions to your GitHub account
<th>Webhook secret </th>
<td>`Input your secret from the previous step` </td>
</tr>
<tr>
<th>Actions </th>
<td>Read & Write </td>
</tr>
<tr>
<th>Repository Administration </th>
<td>Read-only </td>
</tr>
<tr>
<th>Checks </th>
<td>Read & Write </td>
</tr>
<tr>
<th>Code Quality </th>
<td>Read-only </td>
</tr>
<tr>
<th>Code scanning alerts </th>
<td>Read-only </td>
</tr>
<tr>
<th>Commit Statuses </th>
<td>No Access </td>
<td>Read & Write </td>
</tr>
<tr>
<th>Deployments </th>
Expand All @@ -158,6 +180,10 @@ Occasionally, Sentry will request additional permissions to your GitHub account
<th>Issues </th>
<td>Read & Write </td>
</tr>
<tr>
<th>Metadata </th>
<td>Read-only </td>
</tr>
<tr>
<th>Pages </th>
<td>No Access </td>
Expand All @@ -170,6 +196,10 @@ Occasionally, Sentry will request additional permissions to your GitHub account
<th>Repository Contents </th>
<td>Read & Write </td>
</tr>
<tr>
<th>Webhooks </th>
<td>Read & Write </td>
</tr>
<tr>
<th>Single File </th>
<td>No Access </td>
Expand All @@ -178,6 +208,10 @@ Occasionally, Sentry will request additional permissions to your GitHub account
<th>Repository Projects </th>
<td>No Access </td>
</tr>
<tr>
<th>Email addresses </th>
<td>Read-only </td>
</tr>
<tr>
<th>Organization members </th>
<td>Read-only </td>
Expand All @@ -193,6 +227,14 @@ Occasionally, Sentry will request additional permissions to your GitHub account

<table>
<tbody>
<tr>
<th>Check run </th>
<td>Yes </td>
</tr>
<tr>
<th>Check suite </th>
<td>Yes </td>
</tr>
<tr>
<th>Delete </th>
<td>Yes </td>
Expand Down Expand Up @@ -229,6 +271,14 @@ Occasionally, Sentry will request additional permissions to your GitHub account
<th>Pull Request </th>
<td>Yes </td>
</tr>
<tr>
<th>Pull request review </th>
<td>Yes </td>
</tr>
<tr>
<th>Pull request review comment </th>
<td>Yes </td>
</tr>
<tr>
<th>Push </th>
<td>Yes </td>
Expand Down
Loading