From 86eaa1e716d6cea891a346d783c4b821b427ce9a Mon Sep 17 00:00:00 2001 From: Alex Sohn Date: Fri, 24 Jul 2026 16:22:05 -0400 Subject: [PATCH] docs(github): mirror all app permissions and events to GHE setup The GitHub Enterprise section describes a GitHub App that customers create themselves, and its permissions and events had drifted from the Sentry GitHub App used for github.com installs (verified via `gh api /apps/sentry`). Mirror the full set so GitHub Enterprise installs support the same features: - Fix Commit Statuses, which was documented as "No Access" but requires read & write - Add the Actions, Checks, Code Quality, Code scanning alerts, Metadata, Webhooks, and Email addresses permissions - Add the check_run, check_suite, pull_request_review, and pull_request_review_comment events - Note that this app is customer-owned and should be kept in sync with the permissions documented for the github.com app Co-Authored-By: Claude Opus 4.8 (1M context) --- .../source-code-mgmt/github/index.mdx | 52 ++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/docs/integrations/source-code-mgmt/github/index.mdx b/docs/integrations/source-code-mgmt/github/index.mdx index a78f4a5b4907e..8ebf1b271b9a5 100644 --- a/docs/integrations/source-code-mgmt/github/index.mdx +++ b/docs/integrations/source-code-mgmt/github/index.mdx @@ -100,6 +100,12 @@ Occasionally, Sentry will request additional permissions to your GitHub account ### Register new GitHub App + + +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. + + + 1. First, you'll need to generate a webhook secret. For example, in terminal: ``` @@ -142,13 +148,29 @@ Occasionally, Sentry will request additional permissions to your GitHub account Webhook secret `Input your secret from the previous step` + + Actions + Read & Write + Repository Administration Read-only + + Checks + Read & Write + + + Code Quality + Read-only + + + Code scanning alerts + Read-only + Commit Statuses - No Access + Read & Write Deployments @@ -158,6 +180,10 @@ Occasionally, Sentry will request additional permissions to your GitHub account Issues Read & Write + + Metadata + Read-only + Pages No Access @@ -170,6 +196,10 @@ Occasionally, Sentry will request additional permissions to your GitHub account Repository Contents Read & Write + + Webhooks + Read & Write + Single File No Access @@ -178,6 +208,10 @@ Occasionally, Sentry will request additional permissions to your GitHub account Repository Projects No Access + + Email addresses + Read-only + Organization members Read-only @@ -193,6 +227,14 @@ Occasionally, Sentry will request additional permissions to your GitHub account + + + + + + + + @@ -229,6 +271,14 @@ Occasionally, Sentry will request additional permissions to your GitHub account + + + + + + + +
Check run Yes
Check suite Yes
Delete Yes Pull Request Yes
Pull request review Yes
Pull request review comment Yes
Push Yes