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
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.
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 31 additions & 13 deletions develop-docs/integrations/jira/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,44 @@ title: Jira Integration
sidebar_title: Jira
---

Create an [Atlassian Cloud Developer Instance](http://go.atlassian.com/cloud-dev)
## Create an Atlassian Cloud Developer Instance

Atlassian offers a development-specific org option, different from simply having a personal Jira organization. Even if you already have a personal Jira org, it's worth creating a development org, because it will correctly set a number of necessary options for you automatically.
[Atlassian offers a development-specific org](http://go.atlassian.com/cloud-dev) option, different from simply having a personal Jira organization. Even if you already have a personal Jira org, it's worth creating a development org, because it will correctly set a number of necessary options for you automatically.

Set Up ngrok
### Permissions for Certain Features

(This is only necessary if you're developing locally.) [Download](https://ngrok.com/download) and [set up](https://ngrok.com/docs/getting-started/) ngrok, then start an ngrok server.
To enable issue-sync between Jira and a locally hosted Sentry Jira integration, you must set your email address permission to "Anyone". This setting can be found in the [Profile and visiblity](https://id.atlassian.com/manage-profile/profile-and-visibility) page under "Contact".

Configure Jira Settings

## Set Up ngrok

[Download](https://ngrok.com/download) and [set up](https://ngrok.com/docs/getting-started/) ngrok, then start an ngrok server. If you are using getsentry devserver, follow our [ngrok guide](https://develop.sentry.dev/development-infrastructure/ngrok/).

## Installing Local Jira App

1. If you don't have any projects in your Jira org yet, create a new project.
2. In the navigation bar at the top of the screen, go to Apps > Manage Your Apps.
3. At the bottom of the Manage Apps page, click Settings (1).
4. Select Enable Development Mode and Enable Private Listings (2), and click Apply.
2. In the navigation bar at the top of the screen, click on the waffle icon (1), select the desired organization and click "Administration" (2).
![Navigating to Administration](./images/jira-setup1.png)

3. In the navigation bar, click "Products" (3) and under "Sites and products" (4) select the appropriate site/product with your Jira project.
![Navigating to the Correct Site](./images/jira-setup1.5.png)

4. In the sidebar on the left, click on "Connected apps" (5) and then click on the Settings tab (6).
5. Click on the button labeled "Install a private app" (7).
![Navigating to Connected Apps](./images/jira-setup2.png)

6. In the new modal, select JIRA for the product to install the app on (8).
7. For the "App descriptor URL" (9), use the following URL, `https://{YOUR_SENTRY_DOMAIN}/extensions/jira/descriptor/`. Note that if you are running a local devserver, `YOUR_SENTRY_DOMAIN` will be your ngrok (or other tunneling service) domain.
![Filling out Modal](./images/jira-setup3.png)

![Jira Settings](./configure-jira.png)
8. Click "Install app" (10), now if you select the "Installed Apps" (11) tab next to "Settings", you should see your newly installed app listed under "Sentry" (12). (Note: that "Sentry for Jira" is the SaaS integration).
9. On the right the newly installed app click on the three dots and then click "Manage" (13).
![Navigating to App Listing](./images/jira-setup4.png)

5. Reload the page, and Upload App should appear next to Build a New App.
6. Click Upload App and upload the Atlassian Connect descriptor by using the URL  `https://{YOUR_SENTRY_DOMAIN}/extensions/jira/descriptor/`. Note that if you are running a local devserver, `YOUR_SENTRY_DOMAIN` will be your ngrok (or other tunneling service) domain.
10. In the app listing, click on the three dots in the top right and click "Configure" (14).
![Navigating to Configure App](./images/jira-setup5.png)

![Upload Descriptor to Jira](./upload-descriptor.png)
11. Click "Finish Installation in Sentry" and select the desired organization to install the Jira integration on.
![Last step on Jira site](./images/jira-setup6.png)

Follow our [documentation on installing and configuring the Jira integration](https://docs.sentry.io/product/integrations/issue-tracking/jira/) to use the integration.
From here follow our [documentation on installing and configuring the Jira integration](https://docs.sentry.io/product/integrations/issue-tracking/jira/) to use the integration (For reference: We just completed the equivalent to Step 4 under that page's "Install" section).
Loading