Skip to content

Rpatel/docs jira integration #1136

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

Merged
merged 5 commits into from
Jun 13, 2025
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
1 change: 1 addition & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"integrations/github",
"integrations/slack",
"integrations/linear",
"integrations/jira",
"integrations/notion",
"integrations/figma",
"integrations/circleci",
Expand Down
Binary file added docs/images/jira.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 58 additions & 0 deletions docs/integrations/jira.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: "Jira Integration"
sidebarTitle: "Jira"
icon: "jira"
---

import { COMMUNITY_SLACK_URL } from "/snippets/links.mdx";

Integrate Codegen with your Jira workspace to allow agents to interact with issues, manage projects, and keep your team updated.

<img src="/images/jira.png" className="rounded-lg" />

<Note>
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.
</Note>

## Step-by-Step Setup Guide

Follow these steps to successfully connect Codegen to your Jira workspace:

### 1. Create a Dedicated Jira User for Codegen
- In your Jira workspace, create a new user account specifically for Codegen.
- **Email:** Use an address with `codegen` in it, like `yourname+codegen@company_domain.com` or `codegen@company_domain.com`.
- **Name:** Set the user's name to **Codegen**. This makes it easy to identify actions performed by Codegen in Jira.

### 2. Authorize Codegen with the New Jira User
- Log in to Jira as the new Codegen user.
- Go to [Codegen's Jira Integration page](https://codegen.com/integrations/jira).
- Click **Connect Jira Workspace** and complete the OAuth flow **using the Codegen Jira user** you just created.

<Warning>
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.
</Warning>

### 3. Switch Back to Your Own Jira Account
- After connecting, log out of the Codegen Jira user in Jira.
- Log back in with your personal Jira account.

### 4. Use Codegen in Your Workflow
- On any Jira ticket, `@mention` the Codegen user (e.g., `@Codegen`) to assign or notify Codegen about the issue.
- Codegen will interact with the ticket, update statuses, add comments, and link PRs as needed.

## Capabilities

The Jira integration provides read and write access, enabling agents to manage tasks effectively:

- **Read Access:** Fetch issue details, read comments, view project status, list team members.
- **Write Access:** Update issue status (e.g., to "In Progress", "Done"), add comments, link GitHub PRs to issues, create new issues, assign tasks.

## How Agents Use Jira

Agents use the Jira integration to streamline project management:

- **Track Work:** Automatically update the status of issues they are working on.
- **Link Code:** Connect implemented changes (GitHub PRs) directly to the relevant Jira issue.
- **Provide Updates:** Post comments on issues with progress reports, results, or questions.
- **Create Tasks:** Generate new issues for follow-up work, bugs discovered, or sub-tasks.

2 changes: 1 addition & 1 deletion docs/integrations/linear.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ icon: "file-lines"

Linear is designed to orchestrate teams of humans and agents working together. It's the most efficient way to track progress and scale teams of agents to tackle large, complex tasks. Codegen can take a first pass at virtually any issue, breaking down work and making meaningful progress before human review. We recommend letting Codegen handle the initial exploration and implementation of most tasks.

<img src="/images/linear.png" />
<img src="/images/linear.png" className="rounded-lg" />

## Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ icon: "slack"

Connect Codegen to your Slack workspace to enable seamless communication between agents and your team.

<img src="/images/slack.png" />
<img src="/images/slack.png" className="rounded-lg" />

Slack is the most fluid way to communicate with Codegen. Simply tag @codegen in any channel to collaborate directly and give it tasks that leverage all your other integrations. As an agent, Codegen can seamlessly work across platforms—from GitHub to Linear to your databases—all initiated from Slack. We recommend Slack as the lowest barrier entry point for all users.

Expand Down
Loading