|
| 1 | +--- |
| 2 | +title: "Jira Integration" |
| 3 | +sidebarTitle: "Jira" |
| 4 | +icon: "jira" |
| 5 | +--- |
| 6 | + |
| 7 | +import { COMMUNITY_SLACK_URL } from "/snippets/links.mdx"; |
| 8 | + |
| 9 | +Integrate Codegen with your Jira workspace to allow agents to interact with issues, manage projects, and keep your team updated. |
| 10 | + |
| 11 | +<img src="/images/jira.png" className="rounded-lg" /> |
| 12 | + |
| 13 | +<Note> |
| 14 | + The Jira integration is currently in <b>beta</b>. Please reach out in the <a href={COMMUNITY_SLACK_URL}>community</a> to have it enabled for your Codegen account. |
| 15 | +</Note> |
| 16 | + |
| 17 | +## Step-by-Step Setup Guide |
| 18 | + |
| 19 | +Follow these steps to successfully connect Codegen to your Jira workspace: |
| 20 | + |
| 21 | +### 1. Create a Dedicated Jira User for Codegen |
| 22 | +- In your Jira workspace, create a new user account specifically for Codegen. |
| 23 | +- **Email:** Use an address with `codegen` in it, like `yourname+codegen@company_domain.com` or `codegen@company_domain.com`. |
| 24 | +- **Name:** Set the user's name to **Codegen**. This makes it easy to identify actions performed by Codegen in Jira. |
| 25 | + |
| 26 | +### 2. Authorize Codegen with the New Jira User |
| 27 | +- Log in to Jira as the new Codegen user. |
| 28 | +- Go to [Codegen's Jira Integration page](https://codegen.com/integrations/jira). |
| 29 | +- Click **Connect Jira Workspace** and complete the OAuth flow **using the Codegen Jira user** you just created. |
| 30 | + |
| 31 | +<Warning> |
| 32 | + Make sure you are logged in as the Codegen Jira user when authorizing access. This is to ensure Codegen acts on behalf of the new user and not your personal account. |
| 33 | +</Warning> |
| 34 | + |
| 35 | +### 3. Switch Back to Your Own Jira Account |
| 36 | +- After connecting, log out of the Codegen Jira user in Jira. |
| 37 | +- Log back in with your personal Jira account. |
| 38 | + |
| 39 | +### 4. Use Codegen in Your Workflow |
| 40 | +- On any Jira ticket, `@mention` the Codegen user (e.g., `@Codegen`) to assign or notify Codegen about the issue. |
| 41 | +- Codegen will interact with the ticket, update statuses, add comments, and link PRs as needed. |
| 42 | + |
| 43 | +## Capabilities |
| 44 | + |
| 45 | +The Jira integration provides read and write access, enabling agents to manage tasks effectively: |
| 46 | + |
| 47 | +- **Read Access:** Fetch issue details, read comments, view project status, list team members. |
| 48 | +- **Write Access:** Update issue status (e.g., to "In Progress", "Done"), add comments, link GitHub PRs to issues, create new issues, assign tasks. |
| 49 | + |
| 50 | +## How Agents Use Jira |
| 51 | + |
| 52 | +Agents use the Jira integration to streamline project management: |
| 53 | + |
| 54 | +- **Track Work:** Automatically update the status of issues they are working on. |
| 55 | +- **Link Code:** Connect implemented changes (GitHub PRs) directly to the relevant Jira issue. |
| 56 | +- **Provide Updates:** Post comments on issues with progress reports, results, or questions. |
| 57 | +- **Create Tasks:** Generate new issues for follow-up work, bugs discovered, or sub-tasks. |
| 58 | + |
0 commit comments