Skip to content
Open
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions docs/organization/integrations/source-code-mgmt/github/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,41 @@ Here, you'll be able to create or link GitHub issues.

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

### Issue Sync

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.

<Alert title="Note">
Issue sync is available for organizations on the Team, Business, and
Enterprise plans.
</Alert>

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.

![Sync GitHub statuses to Sentry](./img/github-sync.png)

#### User Mappings

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, it can be correctly assigned to the corresponding user in Sentry, and vice versa.

To set up user mappings:

1. Navigate to **Organization Settings** > **Integrations** > **GitHub**.
2. Click "Configure" next to your Github instance.
3. Select the **User Mappings** tab.
4. For each team member, map their GitHub username to their Sentry account.
5. Click **Save Changes** when you're done.

![Configure GitHub user mappings](./img/github-user-mappings.png)

<Alert title="Important">
User mappings are required for assignment syncing to work. Without proper user mappings, assignee information will not sync between Sentry and Github.
</Alert>

<Alert title="Important">
Make sure there is a 1:1 mapping between a Github user and a Sentry user. If there is not, the assignee syncing will not work.
</Alert>

### Resolve via Commit or Pull Request

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:
Expand Down
Loading