Skip to content

Commit 6e22616

Browse files
sfanahataShannon Anahata
authored andcommitted
GitHub app doc updates - updating permissions (#14035)
## DESCRIBE YOUR PR With integrating codecov and emerge into the sentry github app, we're changing the permissions and need to update the doc. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [x] Urgent deadline (GA date, etc.): June 18th - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <shannonanahata@gmail.com>
1 parent 852f361 commit 6e22616

File tree

1 file changed

+32
-9
lines changed
  • docs/organization/integrations/source-code-mgmt/github

1 file changed

+32
-9
lines changed

docs/organization/integrations/source-code-mgmt/github/index.mdx

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ Sentry owner, manager, or admin permissions, and GitHub owner permissions are re
3030

3131
## Installing GitHub
3232

33-
1. Navigate to **Settings > Integrations > [GitHub](https://sentry.io/orgredirect/organizations/:orgslug/settings/integrations/github)**.
33+
34+
1. In Sentry, navigate to **Settings > Integrations > [GitHub](https://sentry.io/orgredirect/organizations/:orgslug/settings/integrations/github)**.
3435

3536
![Install GitHub integration](./img/github-install-page.png)
3637

@@ -46,8 +47,30 @@ Sentry owner, manager, or admin permissions, and GitHub owner permissions are re
4647

4748
![Add repository](./img/github-global-add-repo.png)
4849

50+
9. You can now [configure](#configure) the integration.
51+
4952
The GitHub integration is available for all projects under your Sentry organization. You can connect multiple GitHub organizations to one Sentry organization, but you **cannot** connect a single GitHub organization to multiple Sentry organizations.
5053

54+
While you can install the GitHub integration from [GitHub](https://github.com/apps/sentry-io), we recommend installing it from Sentry for a more streamlined process.
55+
56+
### GitHub Permissions
57+
58+
The following permissions are required for the GitHub integration to work correctly. You must fully opt in to these permissions to use the app. All permissions listed are repo-level permissions, unless otherwise indicated.
59+
60+
| Permission Category | Access Level | Why Sentry Needs It |
61+
|--------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------|
62+
| Administration | Read-only | To respect branch protection rules, determine default branches, and enhance automation. |
63+
| Checks | Read & Write | To show detailed pass/fail results (e.g. test coverage, release health) as GitHub Checks on PRs or commits. |
64+
| Commit Statuses | Read & Write | To post status checks (e.g. test analytics data) to commits in GitHub and integrate with branch protection rules. |
65+
| Contents | Read-only | To fetch source files, commits, and blame data for Suspect Commits, tracking files in Releases. |
66+
| Issues | Read & Write | To create GitHub issues from Sentry events and update linked issues. |
67+
| <span>Members<br/><em>_[Org-level]_</em></span> | Read-only | To map organization users to GitHub identities for improved issue attribution and collaboration. |
68+
| Metadata | Read-only | To identify repository structure, names, default branches, and visibility. |
69+
| Pull Requests | Read & Write | To write comments on pull requests for (1) issues caused by the pull request and (2) to highlight existing issues in the code diff.|
70+
| Webhooks | Read & Write | To subscribe to real-time updates like push events, PRs, and issues.
71+
72+
Occasionally, Sentry will request additional permissions to your GitHub account as new features are introduced. Denying or ignoring the request to update will not affect your current Sentry usage, but may prevent access to future features.
73+
5174
## Installing GitHub Enterprise
5275

5376
### Add new GitHub App
@@ -203,13 +226,13 @@ Commit tracking allows you to hone in on problematic commits. Learn more about [
203226

204227
### Suspect Commits and Suggested Assignees
205228

206-
Once you set up commit tracking, youll be able to see the most recent changes to files found in the issues stack trace with suspect commits.
229+
Once you set up commit tracking, you'll be able to see the most recent changes to files found in the issue's stack trace with suspect commits.
207230

208-
For issues where the files in the stack trace match files included in commits sent to Sentry, youll see the suspect commit, with a link to the commit itself.
231+
For issues where the files in the stack trace match files included in commits sent to Sentry, you'll see the suspect commit, with a link to the commit itself.
209232

210233
![Suspect commits](./img/github-global-suspect-commits.png)
211234

212-
Youll also see that the author of the suspect commit will be listed as a suggested assignee for this issue. To assign the issue to the suggested assignee, click on their icon.
235+
You'll also see that the author of the suspect commit will be listed as a suggested assignee for this issue. To assign the issue to the suggested assignee, click on their icon.
213236

214237
### Issue Management
215238

@@ -243,7 +266,7 @@ To configure issue management manually, once you've navigated to a specific Sent
243266

244267
![Link GitHub issue from Sentry issue](./img/github-global-link-issue.png)
245268

246-
Here, youll be able to create or link GitHub issues.
269+
Here, you'll be able to create or link GitHub issues.
247270

248271
![Create GitHub issue form](./img/github-create-issue.png)
249272

@@ -259,7 +282,7 @@ Fixes MYAPP-317
259282

260283
You can also resolve issues with pull requests by including `fixes <SENTRY-SHORT-ID>` in the title or description.
261284

262-
When Sentry sees this, well automatically annotate the matching issue with a reference to the commit or pull request, and, later, when that commit or pull request is part of a release, well mark the issue as resolved. The commit must be associated with a release. Otherwise, if the commit is squashed, Sentry wont know when the commit has been released, and the issue may never be marked as a regression. With GitHub, we recommend using `fixes <SENTRY-SHORT-ID>` in the body of your pull request that is going to be merged to your main branch.
285+
When Sentry sees this, we'll automatically annotate the matching issue with a reference to the commit or pull request, and, later, when that commit or pull request is part of a release, we'll mark the issue as resolved. The commit must be associated with a release. Otherwise, if the commit is squashed, Sentry won't know when the commit has been released, and the issue may never be marked as a regression. With GitHub, we recommend using `fixes <SENTRY-SHORT-ID>` in the body of your pull request that is going to be merged to your main branch.
263286

264287
### Get Sentry Comments on Pull Requests
265288

@@ -342,7 +365,7 @@ For certain native platforms, the stack trace will look different. In cases like
342365

343366
![Highlighting where in the UI to find the file path for native stack traces](./img/code-mappings-stacktrace-native.png)
344367

345-
If you arent sure, you can look at the event JSON by clicking on the `{}` button in the event header. Find the text in the frame's `filename` or `abs_path`.
368+
If you aren't sure, you can look at the event JSON by clicking on the `{}` button in the event header. Find the text in the frame's `filename` or `abs_path`.
346369

347370
<Include name="common-imgs/code-mappings-event-json" />
348371

@@ -366,13 +389,13 @@ For more details, see the full documentation for [Code Owners](/product/issues/o
366389

367390
### GitHub Single Sign-On
368391

369-
Single sign-on (or SSO) allows you to manage your organizations entire membership via a third-party provider.
392+
Single sign-on (or SSO) allows you to manage your organization's entire membership via a third-party provider.
370393

371394
For more details, see the full documentation for [Single Sign-on](/organization/authentication/sso/).
372395

373396
## Troubleshooting
374397

375-
If youre having issues adding a GitHub repository:
398+
If you're having issues adding a GitHub repository:
376399

377400
- Make sure you are the Owner of your GitHub organization.
378401
- [Disconnect](https://sentry.io/account/settings/identities/), and then [reconnect](https://sentry.io/account/settings/social/associate/github/) your GitHub Identity.

0 commit comments

Comments
 (0)