Skip to content

Commit d8f2f30

Browse files
authored
Rpatel/docs jira integration (#1136)
# Motivation <!-- Why is this change necessary? --> # Content <!-- Please include a summary of the change --> # Testing <!-- How was the change tested? --> # Please check the following before marking your PR as ready for review - [ ] I have added tests for my changes - [ ] I have updated the documentation or added new documentation as needed --------- Co-authored-by: rushilpatel0 <[email protected]>
1 parent e0e18cf commit d8f2f30

File tree

5 files changed

+61
-2
lines changed

5 files changed

+61
-2
lines changed

docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"integrations/github",
3535
"integrations/slack",
3636
"integrations/linear",
37+
"integrations/jira",
3738
"integrations/notion",
3839
"integrations/figma",
3940
"integrations/circleci",

docs/images/jira.png

173 KB
Loading

docs/integrations/jira.mdx

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
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+

docs/integrations/linear.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: "file-lines"
66

77
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.
88

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

1111
## Installation
1212

docs/integrations/slack.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: "slack"
66

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

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

1111
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.
1212

0 commit comments

Comments
 (0)