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
44 changes: 22 additions & 22 deletions docs/organization/integrations/source-code-mgmt/github/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ There are three types of GitHub integrations, so make sure you're choosing the c

For these accounts, follow the '[Installing GitHub Enterprise](#installing-github-enterprise)' instructions.

- [Seer GitHub App](#installing-the-seer-github-app) - For [Seer](/product/ai-in-sentry/seer) to make Pull Requests for Issue Fixes and for [AI Code Review](/product/ai-in-sentry/ai-code-review) to analyze your Pull Requests.
- [Seer GitHub App](#installing-the-seer-github-app) - For [Seer](/product/ai-in-sentry/seer) to make Pull Requests for Issue Fixes.

### Check Your Domain

Expand All @@ -38,7 +38,7 @@ Sentry owner, manager, or admin permissions, and GitHub owner permissions are re

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

![Install GitHub integration](./img/github-install-page.png)
![Install GitHub integration =800x](./img/github-install-page.png)

2. If you have the legacy GitHub integration installed, use the button next to GitHub to **Upgrade**. If you don't have the legacy GitHub integration installed, use the button to **Install**.

Expand All @@ -50,7 +50,7 @@ Sentry owner, manager, or admin permissions, and GitHub owner permissions are re
7. On your new GitHub instance in Sentry, click "Configure".
8. All of your repositories will be added by default, you just have to refresh your screen. To only add select repositories, choose them from the dropdown list. _Make sure you have given Sentry access to these repositories in GitHub in the previous steps._

![Add repository](./img/github-global-add-repo.png)
![Add repository =500x](./img/github-global-add-repo.png)

9. You can now [configure](#configure) the integration.

Expand Down Expand Up @@ -192,15 +192,15 @@ Occasionally, Sentry will request additional permissions to your GitHub account

3. Click "Add Installation".

![Add Installation](./img/github-e-add-installation.png)
![Add Installation =700x](./img/github-e-add-installation.png)

4. Fill out the following form with information from your GitHub apps configuration page. The installation URL must be resolvable over the Internet.

![GitHub Enterprise configuration form](./img/github-e-form.png)

You'll need to generate a private key on your GitHub apps configuration page, and paste the entire contents into the **GitHub App Private Key** field.

![Generate private key](./img/github-e-generate-private-key.png)
![Generate private key =550x](./img/github-e-generate-private-key.png)

For example, in terminal:

Expand All @@ -210,30 +210,30 @@ Occasionally, Sentry will request additional permissions to your GitHub account

5. Click "Configure" and then a GitHub install window will pop up. Select which repositories Sentry should have access to (or select all repositories) and click "Install".

![Install GitHub Enterprise confirmation modal](./img/github-e-repo-access.png)
![Install GitHub Enterprise confirmation modal =700x](./img/github-e-repo-access.png)

6. You will then be redirected back to Sentry. On your new GitHub Enterprise instance, click "Configure".

![Configure GitHub enterprise](./img/github-e-configure.png)
![Configure GitHub enterprise =800x](./img/github-e-configure.png)

7. Add any repositories that you want to collect commit data from. _Make sure you have given Sentry access to these repositories in GitHub in the previous steps._
![Add GitHub Enterprise repository](./img/github-e-add-repo.png)
![Add GitHub Enterprise repository =600x](./img/github-e-add-repo.png)

GitHub Enterprise should now be enabled for all projects under your Sentry organization.

## Installing the Seer GitHub App

The [Seer GitHub App](https://github.com/apps/seer-by-sentry) is used by [Seer](/product/ai-in-sentry/seer) to make Pull Requests for Issue Fixes and for [AI Code Review](/product/ai-in-sentry/ai-code-review) to analyze your Pull Requests.
The [Seer GitHub App](https://github.com/apps/seer-by-sentry) is used by [Seer](/product/ai-in-sentry/seer) to make Pull Requests for Issue Fixes.

To install the Seer GitHub App, simply follow the installation steps to install the GitHub App for the specified organization/repositories you need. You can find the Seer GitHub App [here](https://github.com/apps/seer-by-sentry).

- For [Issue Fix](/product/ai-in-sentry/seer#issue-fix), you will now be able to create pull requests in the installed locations.
For [Issue Fix](/product/ai-in-sentry/seer#issue-fix), you will now be able to create pull requests in the installed locations.

- For [AI Code Review](/product/ai-in-sentry/ai-code-review), continue following the instructions in the [Sentry Prevent AI](/product/ai-in-sentry/sentry-prevent-ai#getting-started) documentation.
## Configure GitHub Integration

## Configure
Use GitHub to [track commits](#commit-tracking), identify [suspect commits](#suspect-commits-and-suggested-assignees), [resolve via commit or PR](#resolve-via-commit-or-pull-request), [manage issues](#issue-management), and use AI for code review.

Use GitHub to [track commits](#commit-tracking), identify [suspect commits](#suspect-commits-and-suggested-assignees), [resolve via commit or PR](#resolve-via-commit-or-pull-request) and [manage issues](#issue-management).
To enable [AI Code Review](/product/ai-in-sentry/ai-code-review), turn on the `Show Generative AI Features` and `Enable AI Code Review` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/).

### Commit Tracking

Expand All @@ -245,7 +245,7 @@ Once you set up commit tracking, you'll be able to see the most recent changes t

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.

![Suspect commits](./img/github-global-suspect-commits.png)
![Suspect commits =700x](./img/github-global-suspect-commits.png)

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.

Expand All @@ -270,19 +270,19 @@ Issue management can be configured in two ways - automatically or manually.

To configure issue management automatically, create an [**Issue Alert**](/product/alerts-notifications/issue-alerts/). When selecting the [**action**](/product/alerts/create-alerts/issue-alert-config/#then-conditions-actions), choose **Create a new GitHub issue**.

![Create GitHub Issue alert rule action](./img/github-ticket-rule.png)
![Create GitHub Issue alert rule action =700x](./img/github-ticket-rule.png)

A GitHub issue will be created automatically when the alert has been triggered.

#### Manually

To configure issue management manually, once you've navigated to a specific Sentry issue, you'll find the **Linked Issues** section on the right hand panel.

![Link GitHub issue from Sentry issue](./img/github-global-link-issue.png)
![Link GitHub issue from Sentry issue =800x](./img/github-global-link-issue.png)

Here, you'll be able to create or link GitHub issues.

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

### Issue Sync

Expand Down Expand Up @@ -339,15 +339,15 @@ Sentry can comment on merged and open pull requests. These features are automati

If a recently merged pull request is suspected of causing an issue, Sentry will comment on it to surface the issue, as shown in the example below.

![Sentry comment on suspect pull request in GitHub](./img/sentry-github-pr-comment.png)
![Sentry comment on suspect pull request in GitHub =700x](./img/sentry-github-pr-comment.png)

Sentry will only comment on pull requests less than two weeks old that are associated with suspect commits. The comment will continuously be updated with up to five issues the pull request is suspected to have caused.

#### Open Pull Request Comments

When a pull request is opened, Sentry will parse the filenames and function names modified in the pull request from the PR diff to find recent unhandled, unresolved issues associated with your pull request.

![Sentry comment on open pull request in GitHub](./img/sentry-github-open-pr-comment.png)
![Sentry comment on open pull request in GitHub =700x](./img/sentry-github-open-pr-comment.png)

Sentry will comment on the pull request with up to five issues per file that were first seen within the past 90 days and were last seen within the past 14 days.

Expand All @@ -357,17 +357,17 @@ This feature requires [code mappings](/product/issues/suspect-commits/#2-set-up-

If there are users committing to GitHub repositories linked to Sentry and they're not members of your organization, Sentry detects them as missing members. Once a month, Sentry sends organization owners and managers an email reminding them to invite those users to join their org. Sentry also shows a banner to invite missing members in the **Settings > Members** page.

![GitHub missing members invite banner](./img/github-missing-members-banner.png)
![GitHub missing members invite banner =700x](./img/github-missing-members-banner.png)

The banner shows the 5 most active contributors that are not yet in the organization. To see all missing members (up to 50), click "View All" in the banner. To snooze the banner, click the ellipsis, then select "Hide Missing Members".

Clicking "View All" on the invite banner will display the invite modal. From here, you can select multiple users and assign roles and teams before inviting them.

![GitHub missing members invite modal](./img/github-missing-members-modal.png)
![GitHub missing members invite modal =750x](./img/github-missing-members-modal.png)

By default, this feature is automatically enabled once your GitHub integration has been set up. To disable it, go to **Settings > Integrations > GitHub** and toggle it off.

![How to disable missing member detection](./img/github-org-settings.png)
![How to disable missing member detection =750x](./img/github-org-settings.png)

### Stack Trace Linking

Expand Down
15 changes: 5 additions & 10 deletions docs/product/ai-in-sentry/ai-code-review/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,17 @@ AI Code Review helps you reviews your code changes, predicting errors and offeri

## Getting Started

To enable AI Code Review in your GitHub organization or on specific repositories, you need to install the [Seer by Sentry GitHub app](/organization/integrations/source-code-mgmt/github/#installing-the-seer-github-app). This allows the assistant to analyze pull requests, provide insights, and write tests. **You must also have the [Sentry Github integration](/organization/integrations/source-code-mgmt/github/) enabled.**
To enable AI Code Review in your GitHub organization or on specific repositories:

1. Have the [Sentry Github integration](/organization/integrations/source-code-mgmt/github/) enabled.

1. Install the [Seer by Sentry GitHub app](/organization/integrations/source-code-mgmt/github/#installing-the-seer-github-app) in your GitHub organization or specific repositories.
2. Enable these required settings in your Sentry [organization settings](https://sentry.io/orgredirect/settings/:orgslug/):
- `Show Generative AI Features`
- `Enable AI Code Review`

If you're not an admin, share the Seer by Sentry GitHub App Integration link with your organization's admin or owner to install it.

## AI Code Review Commands

After installing the app, AI Code Review can help you in three ways:
Ways AI Code Review can help you:

1. **Error Prediction** - When you create a pull request and set it to `Ready for Review`, AI Code Review will check for errors in your code. If no error is found, you will see a 🎉 emoji as a reaction to your PR description. Otherwise, AI Code Review will add comments to your PR. **Note:** We skip review if you set your PR to `draft` on creation.

Expand All @@ -53,11 +52,7 @@ Once you have added a comment, the assistant will reply, acknowledging the reque

- **Why aren't `@sentry` commands working?**

AI Code Review will respond with a message to enable the `Show Generative AI Features` and `Enable PR Review and Test Generation` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/), if you have not already enabled them. Once enabled, try `@sentry review` again to run AI Code Review.

- **Is AI Code Review available in the EU region?**

Not currently, although we're working on it.
AI Code Review will respond with a message to enable the `Show Generative AI Features` and `Enable AI Code Review` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/), if you have not already enabled them. Once enabled, try `@sentry review` again to run AI Code Review.

- **When does Error Prediction run?**

Expand Down
2 changes: 1 addition & 1 deletion docs/product/ai-in-sentry/seer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ To start using Seer's capabilities in your Sentry-enabled projects, follow these
> **Note**: You can monitor your Seer usage in the [Stats & Usage tab](https://sentry.io/settings/stats/) and can learn more about managing your Seer budget [here](/pricing/quotas/manage-seer-budget/).
4. **Start Using**: Look for Seer options in your issue details pages

To start using Seer to for AI code reviews, [configure the Seer GitHub App](/organization/integrations/source-code-mgmt/github/#installing-the-seer-github-app).
You can also use Seer for [AI code reviews](/product/ai-in-sentry/ai-code-review) by enabling the [GitHub integration](/organization/integrations/source-code-mgmt/github/) and turning on the `Enable AI Code Review` setting in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/).

## Privacy and security

Expand Down
Loading