Skip to content

Commit 6886324

Browse files
iamrajjoshisfanahataShannon Anahata
authored
✨ feat(github): add github issue sync docs (#15408)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR Add docs for new issue sync integrations features. Looks similar to Jira & Azure DevOps docs <img width="675" height="978" alt="image" src="https://github.com/user-attachments/assets/5b1dd7b4-f613-40dc-9155-1cc8567c1b98" /> ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] 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:* - [x] 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) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/) --------- Co-authored-by: Shannon Anahata <[email protected]> Co-authored-by: Shannon Anahata <[email protected]>
1 parent a28a03a commit 6886324

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed
99.8 KB
Loading
31.6 KB
Loading

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,37 @@ Here, you'll be able to create or link GitHub issues.
284284

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

287+
### Issue Sync
288+
289+
To minimize duplication in issue tracking, you can sync comments, assignees, and status updates for Sentry issues to Github issues and vice versa. When you delegate an issue to an assignee or update a status on Github, the updates will also populate in Sentry. When you resolve an issue in Sentry, the issue status will automatically update in Github. When Github issues are marked as closed, you can configure how the corresponding issue in Sentry should be resolved.
290+
291+
<Alert title="Note">
292+
Issue sync is available for organizations on the Team, Business, and
293+
Enterprise plans.
294+
</Alert>
295+
296+
To configure Issue sync, navigate to **Organization Settings** > **Integrations**, and click "Configure" next to your Github instance. On the following page, you can configure how you want information to sync between Sentry and Github.
297+
298+
![Sync GitHub statuses to Sentry](./img/github-sync.png)
299+
300+
#### User Mappings
301+
302+
For assignee syncing to work properly between Sentry and Github, you'll need to set up user mappings. This ensures that when an issue is assigned to someone in Github, you can correctly assign it to the corresponding user in Sentry, and vice versa. **NOTE:** Without proper user mappings, assignee information will not sync between Sentry and Github.
303+
304+
To set up user mappings:
305+
306+
1. Navigate to **Organization Settings** > **Integrations** > **GitHub**.
307+
2. Click "Configure" next to your Github instance.
308+
3. Select the **User Mappings** tab.
309+
4. For each team member, map their GitHub username to their Sentry account.
310+
5. Click **Save Changes** when you're done.
311+
312+
![Configure GitHub user mappings](./img/github-user-mappings.png)
313+
314+
<Alert title="Important">
315+
Make sure there is a 1:1 mapping between a Github user and a Sentry user. If there is not, assignee syncing will not work.
316+
</Alert>
317+
287318
### Resolve via Commit or Pull Request
288319

289320
Once you are sending commit data, you can start resolving issues by including `fixes <SENTRY-SHORT-ID>` in your commit messages. For example, a commit message might look like:

0 commit comments

Comments
 (0)