You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## 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>
9. You can now [configure](#configure) the integration.
51
+
49
52
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.
50
53
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.
| 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
+
51
74
## Installing GitHub Enterprise
52
75
53
76
### Add new GitHub App
@@ -203,13 +226,13 @@ Commit tracking allows you to hone in on problematic commits. Learn more about [
203
226
204
227
### Suspect Commits and Suggested Assignees
205
228
206
-
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.
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.
207
230
208
-
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.
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.
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.
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.
213
236
214
237
### Issue Management
215
238
@@ -243,7 +266,7 @@ To configure issue management manually, once you've navigated to a specific Sent
243
266
244
267

245
268
246
-
Here, you’ll be able to create or link GitHub issues.
269
+
Here, you'll be able to create or link GitHub issues.
You can also resolve issues with pull requests by including `fixes <SENTRY-SHORT-ID>` in the title or description.
261
284
262
-
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.
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.
263
286
264
287
### Get Sentry Comments on Pull Requests
265
288
@@ -342,7 +365,7 @@ For certain native platforms, the stack trace will look different. In cases like
342
365
343
366

344
367
345
-
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`.
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`.
@@ -366,13 +389,13 @@ For more details, see the full documentation for [Code Owners](/product/issues/o
366
389
367
390
### GitHub Single Sign-On
368
391
369
-
Single sign-on (or SSO) allows you to manage your organization’s 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.
370
393
371
394
For more details, see the full documentation for [Single Sign-on](/organization/authentication/sso/).
372
395
373
396
## Troubleshooting
374
397
375
-
If you’re having issues adding a GitHub repository:
398
+
If you're having issues adding a GitHub repository:
376
399
377
400
- Make sure you are the Owner of your GitHub organization.
378
401
-[Disconnect](https://sentry.io/account/settings/identities/), and then [reconnect](https://sentry.io/account/settings/social/associate/github/) your GitHub Identity.
0 commit comments