Skip to content

jira.mdx

Latest commit

 

History

History
113 lines (77 loc) · 5.29 KB

jira.mdx

File metadata and controls

113 lines (77 loc) · 5.29 KB
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.

The Jira integration is currently in beta. Please reach out in the community to have it enabled for your Codegen account.

Step-by-Step Setup Guide

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

1. Enable User-Installed Apps in Jira

  • In your Jira workspace, ensure that user-installed apps are enabled.
  • Make sure the setting to allow user-installed apps is enabled. This is required for the Codegen integration to work properly.
If you don't have admin access to enable user-installed apps, contact your Jira administrator to enable this setting before proceeding.

2. 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.

3. Authorize Codegen with the New Jira User

  • Log in to Jira as the new Codegen user.
  • Go to Codegen's Jira Integration page.
  • Click Connect Jira Workspace and complete the OAuth flow using the Codegen Jira user you just created.
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.

Setup & Authorization

When connecting Codegen to your Jira workspace, you may encounter an authorization screen from Atlassian that requires additional setup. Here's what to expect and how to resolve common authorization issues:

OAuth Authorization Process

During the OAuth flow, Atlassian will display an authorization screen showing:

  1. App Information: Details about Codegen requesting access to your Jira account
  2. Permissions Requested: A list of specific permissions Codegen needs (see below)
  3. Authorization Options: Buttons to approve or deny access

Site Admin Authorization Requirement

Common Issue: You may see a message stating that a site administrator needs to authorize Codegen before you can proceed.

Resolution Steps:

  1. Contact Your Jira Administrator: Reach out to your Jira site administrator and ask them to:

    • Log in to your Jira instance as an administrator
    • Navigate to the same OAuth authorization URL
    • Review and approve Codegen's access request

  2. Administrator Approval Process: Your admin will see the same authorization screen and can approve Codegen for your entire organization

  3. Retry Authorization: Once your administrator has approved Codegen, return to the authorization flow and complete the process

Permissions Requested by Codegen

Codegen requests the following permissions from your Jira workspace:

  • jira-webhook: Allows Codegen to receive notifications about issue updates, comments, and status changes
  • jira-user: Enables Codegen to read user information and perform actions on behalf of the authorized user
  • jira-work: Grants access to read and write issue data, including creating, updating, and commenting on issues

Privacy & Data Access

What Codegen Can Access:

  • Issue details, comments, and status information
  • Project information and team member lists
  • User profile information for the authorized account

What Codegen Cannot Access:

  • Personal information beyond what's necessary for Jira integration
  • Data from other Atlassian products unless explicitly authorized
  • Administrative settings or sensitive configuration data

Data Usage: Codegen only uses this data to perform the specific actions you request, such as updating issue status, adding comments, or linking GitHub PRs to Jira issues.

4. 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.

5. 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.