Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion develop-docs/integrations/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For local development make sure to use your ngrok URL as the prefix.
</Alert>

<CreateGitHubAppForm
url="https://github.com/organizations/:org/settings/apps/new?name=:org-Sentry-Integration&public=false&members=read&emails=read&administration=read&contents=write&checks=write&statuses=write&issues=write&pull_requests=write&repository_hooks=write&url=:url-prefix&callback_urls[]=:url-prefix%2Fauth%2Fsso%2F&callback_urls[]=:url-prefix%2Fextensions%2Fgithub%2Fsetup%2F&setup_url=:url-prefix%2Fextensions%2Fgithub%2Fsetup%2F&webhook_url=:url-prefix%2Fextensions%2Fgithub%2Fwebhook%2F&events[]=push&events[]=pull_request&webhook_active=true"
url="https://github.com/organizations/:org/settings/apps/new?name=:org-Sentry-Integration&public=false&members=read&emails=read&administration=read&contents=write&checks=write&statuses=write&issues=write&pull_requests=write&repository_hooks=write&actions=write&code_quality=read&security_events=read&url=:url-prefix&callback_urls[]=:url-prefix%2Fauth%2Fsso%2F&callback_urls[]=:url-prefix%2Fextensions%2Fgithub%2Fsetup%2F&setup_url=:url-prefix%2Fextensions%2Fgithub%2Fsetup%2F&webhook_url=:url-prefix%2Fextensions%2Fgithub%2Fwebhook%2F&events[]=push&events[]=pull_request&events[]=check_run&events[]=check_suite&events[]=pull_request_review&events[]=pull_request_review_comment&webhook_active=true"
defaultOrg="your-organization"
defaultUrlPrefix="https://your-sentry-url-prefix.com"
/>
Expand All @@ -45,7 +45,10 @@ When prompted for permissions, choose the following:
| Repository / Administration | Read-only |
| Organization permissions / members (optional) | Read-only |
| Account permissions / Email addresses (optional) | Read-only |
| Repository / Actions | Read & write |
| Repository / Checks | Read & write |
| Repository / Code quality | Read-only |
| Repository / Code scanning alerts | Read-only |
| Repository / Commit Statuses | Read & write |
| Repository / Contents | Read & write |
| Repository / Issues | Read & write |
Expand All @@ -54,6 +57,8 @@ When prompted for permissions, choose the following:

When prompted to subscribe to events, choose the following:

- Check run
- Check suite
- Delete
- Fork
- Issue comment
Expand All @@ -63,6 +68,8 @@ When prompted to subscribe to events, choose the following:
- Organization
- Public
- Pull Request
- Pull request review
- Pull request review comment
- Push
- Release
- Repository
Expand Down
1 change: 1 addition & 0 deletions docs/integrations/source-code-mgmt/github/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ The following permissions are required for the GitHub integration to work correc
| Checks | Read & Write | To show detailed pass/fail results (e.g. test coverage, release health, AI Code Review) as GitHub Checks on PRs or commits. |
| Commit Statuses | Read & Write | To post status checks to commits in GitHub and integrate with branch protection rules. |
| Contents | Read & Write | To fetch source files, commits, and blame data for Suspect Commits, track files in Releases, and create branches and pull requests. |
| <span>Email Addresses<br/><em>_[Account-level]_</em></span> | Read-only | To associate GitHub identities with Sentry accounts for GitHub SSO and contributor mapping. |
| Issues | Read & Write | To create GitHub issues from Sentry events and update linked issues. |
| <span>Members<br/><em>_[Org-level]_</em></span> | Read-only | To map organization users to GitHub identities for improved issue attribution and collaboration. |
| Metadata | Read-only | To identify repository structure, names, default branches, and visibility. |
Expand Down
Loading