Integrate your Source Code Repository
Now that you created a release, the next step is to integrate your GitHub repository. Sentry will use the repository metadata to help you resolve your issues faster.
Description & Objectives
You can tell Sentry which commits are associated with your release — this is called Commit Tracking. This allows Sentry to display:
- Suspect Commits - commits which likely caused the issue, with a link to the commit itself.
- Suggested Assignees - lists the authors of those commits and suggests their assignment to resolve the issue.
In this part, you will:
- Integrate your Sentry organization with your GitHub account and repository — this will give Sentry access to your commit metadata.
- Set up commit tracking. In your release process, after creating the release object in Sentry, associate it with commits from your linked repository.
Step 1: Integrate your GitHub Account & Repositories
To integrate GitHub with your Sentry org, follow the instructions in the Global Integrations documentation
For the last step, add the
sentry-react-demorepository from your GitHub account
GitHub should now be enabled for all projects under your Sentry organization.
Step 2: Set Up Commit Tracking
In the demo project, we’re using a Makefile to handle our CI/CD related tasks.
Note: If you’re using your own source code and don’t have a Makefile, you could optionally run the
sentry-clicommands used in this tutorial directly from the
Makefilein your project
Add the following target at the bottom of the file:
associate_commits: sentry-cli releases -o $(SENTRY_ORG) -p $(SENTRY_PROJECT) set-commits --auto $(REACT_APP_RELEASE_VERSION)
The command associates commits with the release. The –auto flag automatically determines the repository name, and associates commits between the previous release’s commit and the current head commit with the release.
The new target
associate_commitswill be invoked as part of the
setup_releasetarget, add it at the end:
setup_release: create_release upload_sourcemaps associate_commits
Your Makefile should look like this:
If your terminal is still serving the demo app on localhost, press
^Cto shut it down
Build, deploy, and rerun the project by running:
$ npm run deploy
In the terminal log, notice that the sentry-cli identified the GitHub repository.
Step 3: Suspect Commits and Suggested Assignees
Now suspect commits and suggested assignees should start appearing on the issue page. We determine these by tying together the commits in the release, files touched by those commits, files observed in the stack trace, authors of those files, and ownership rules.
Refresh the browser and generate an error by adding products to your cart and clicking Checkout
Check your Email for the alert about the new error and click View on Sentry to open the issue page
In the main panel, notice the
SUSPECT COMMITSsection now points to a commit that most likely introduced the error. You can click on the commit button to see the actual commit details on GitHub
In the right-side panel, under
Suggested Assignees— you’ll see that the author of the suspect commit is listed as a suggested assignee for this issue
You can assign the suggested assignee to the issue by clicking on the icon. However, in this case, the commit originates in the repository upstream, and the suggested assignee is not part of your organization. Alternatively, you can manually assign the issue to other users or teams assigned to the project.
Click on the
ASSIGNEEdropdown and select one of the project users or teams
From the main panel, find the
releasetag and hover over the
In the release popup, notice the release now contains the commit data
Click on the release
iicon to open the release details page
Commitstab. Notice that release now contains the associated list of commits