-
Notifications
You must be signed in to change notification settings - Fork 17
docs: publish Jira integration page with self-serve setup flow #338
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| --- | ||
| title: Jira integration | ||
| draft: true | ||
| sidebar: | ||
| label: "Jira" | ||
| description: >- | ||
|
|
@@ -23,19 +22,35 @@ The Jira integration lets your team kick off cloud agent runs directly from Jira | |
|
|
||
| ### Setup | ||
|
|
||
| #### 1. Install the Oz app in Jira | ||
| #### 1. Open the Jira app installation page | ||
|
|
||
| The Oz app is not yet published to the Atlassian marketplace. Install the Oz app into your Jira Cloud site using the link provided by your Warp contact. Only Jira site admins can install apps. | ||
| In the [Oz web app](https://oz.warp.dev/integrations), find Jira and click **Set up**. On the Atlassian installation page, click **Get app**. | ||
|
|
||
| #### 2. Connect your Jira site to Warp | ||
| #### 2. Install Oz on your Jira site | ||
|
|
||
| After installing the app, open the app's **Configure** screen inside Jira. This takes you to a Warp page to connect your app installation to your Warp workspace. | ||
| Choose the Jira Cloud site you want to connect, review the requested permissions, and install Oz. Only Jira site admins can install apps. | ||
|
|
||
| Once connected, the integration is active for all members of your Warp team. | ||
| #### 3. Open the Oz configuration page | ||
|
|
||
| #### 3. (Optional) Configure the default environment, model, and harness | ||
| In your Jira site, open **Manage apps**. Find Oz, open its three-dot actions menu, then click **Configure**. | ||
|
|
||
| In the [Oz web app](https://oz.warp.dev/integrations), open your Jira integration to set the default [environment](/platform/environments/), model, and harness Oz uses for Jira-triggered runs. If you don't set these, Oz uses your team's default configuration. | ||
| The configuration page URL for the production app follows this pattern: | ||
|
|
||
| ```text | ||
| https://<your-site-subdomain>.atlassian.net/jira/settings/apps/configure/40dbc167-16d9-4b68-9752-277c5a52aa01/34808a52-a321-44c2-bac4-a15eb316df50/static/warp-jira-configure/34808a52-a321-44c2-bac4-a15eb316df50 | ||
| ``` | ||
|
|
||
| Replace `<your-site-subdomain>` with your Jira Cloud site subdomain. | ||
|
|
||
| #### 4. Connect Jira to your Warp workspace | ||
|
|
||
| On the Oz configuration page in Jira, click **Connect to Warp**. Sign in to Warp if prompted. Warp automatically binds the Jira installation to your Warp workspace. | ||
|
|
||
| The confirmation page displays **Jira connected** when the connection succeeds. Jira-triggered runs are now available to members of the connected Warp workspace. | ||
|
|
||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. could be helpful to include a screenshot here! |
||
| #### 5. (Optional) Configure the default environment, model, and harness | ||
|
|
||
| Return to the [Integrations page in the Oz web app](https://oz.warp.dev/integrations), then click **Edit Jira** to set the default [environment](/platform/environments/), model, harness, and agent for Jira-triggered runs. If you don't change these settings, Oz uses your workspace's default configuration. | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -45,6 +60,20 @@ Add the label **`oz-agent`** to any Jira issue. Oz will pick it up, post a comme | |
|
|
||
| When the run finishes, Oz posts a summary comment to the issue with links to any pull requests or branches it created, along with a link to the full conversation in Warp. To track runs across your team, open the [Agent Management Panel](/platform/managing-cloud-agents/) in the Warp app, where Jira-triggered runs appear in the **All** tab. | ||
|
|
||
| #### Connecting your Jira account to Warp | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is there anything an admin needs to do on the jira side? can anyone install warp / oz onto jira, without admin permissions? |
||
|
|
||
| The first time you trigger a run, Oz posts a comment prompting you to connect your Jira account to Warp. Connecting attributes your Jira-triggered runs to your Warp account; the run starts either way. | ||
|
|
||
| 1. Follow the link in the comment to open the Warp page in your Jira personal settings. The link for the production app follows this pattern: | ||
|
|
||
| ```text | ||
| https://<your-site-subdomain>.atlassian.net/jira/settings/personal/apps/40dbc167-16d9-4b68-9752-277c5a52aa01/34808a52-a321-44c2-bac4-a15eb316df50 | ||
| ``` | ||
|
|
||
| 2. Click **Connect to Warp**. A Warp page opens and links your account automatically. Sign in to Warp first if prompted. | ||
|
|
||
| The page displays **Jira account connected** when the link succeeds, and the settings page shows a **Connected to Warp** badge. Runs you trigger from then on are attributed to you. | ||
|
|
||
| --- | ||
|
|
||
| ### Troubleshooting | ||
|
|
@@ -54,11 +83,8 @@ If Oz doesn't respond after adding the label, check that: | |
| * The Oz app is installed and the workspace is connected (see the app's **Configure** screen in Jira). | ||
| * The issue is in Jira Cloud (not Server or Data Center). | ||
|
|
||
| :::tip | ||
| When a Jira-triggered run can't start, Oz posts an error comment on the issue. Common codes: | ||
|
|
||
| * [`feature_not_available`](/reference/api-and-sdk/troubleshooting/errors/feature-not-available/) - your plan doesn't support integrations. | ||
| * [`integration_disabled`](/reference/api-and-sdk/troubleshooting/errors/integration-disabled/) - the integration was removed or disabled. | ||
| :::note | ||
| When a Jira-triggered run fails to start, Oz updates its comment on the issue to say it could not start the task. Re-add the `oz-agent` label to try again; a new attempt starts a new comment thread. | ||
| ::: | ||
|
|
||
| For other issues, reach out to your Warp contact or join the [Warp community on Slack](https://go.warp.dev/join-preview). | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
might be worth linking them out to the jira platform somewhere here, just for ease of access
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also, i think worth mentioning a bit about how this affects your jira team - once you install this on jira, does everyone immediately have access to it? does everyone else have to auth into warp / oz?