Skip to main content

Integrating Copilot cloud agent with Jira

You can use the GitHub integration in Jira to provide context and open pull requests, all from within your Jira workspace.

Who can use this feature?

Available for all paid Copilot plans.

Note

GitHub Copilot uses AI. Check for mistakes. See Application card: GitHub Copilot Agents.

The GitHub Copilot integration in Jira allows you to invoke Copilot cloud agent without leaving your Jira workspace. From within Jira you can initiate cloud agent sessions and open pull requests, using the context of the work item's title, description, labels, comments, and any Atlassian custom fields such as acceptance criteria.

Prerequisites

  • You must have a GitHub account with access to Copilot through a paid Copilot plan.
  • You must have a Jira Cloud account, Jira must be an AI-enabled app, and Rovo must be activated for your organization. See Activate AI for apps in the Atlassian documentation.
  • Installation and authentication must be completed for both Jira and GitHub.

Installation

To install the GitHub Copilot for Jira app and authorize it for your GitHub organization or enterprise account, you need:

  • Administrator permission for your Jira site.
  • Owner or GitHub App manager permissions for your GitHub organization.

This integration relies on an Atlassian Forge application and a GitHub application. Both are required for the integration. Once successfully installed, authorized users of the Jira workspace with write access to a GitHub repository will be able to trigger the agent from Jira.

Installing the GitHub Copilot for Jira app for GitHub.com

  1. Navigate to the GitHub Copilot for Jira installation page on the Atlassian Marketplace.

  2. Click Get it now.

  3. Select the Atlassian site you want to install the GitHub application in.

  4. Click Review to check the installation details, and then click Get it now.

    Once GitHub Copilot for Jira is installed in your Jira site, you need to authorize the app to access your GitHub organization and repositories.

  5. Click Configure in the confirmation message in Jira after installation.

  6. If you are not already logged in to GitHub, click the highlighted Log in to GitHub and follow the prompts to log in to your GitHub account and authorize the application.

    • If your organization or enterprise uses single sign-on (SSO), you may need to start an active SAML session for your organization and perform an additional authorization step.
  7. Click Install app to give the app permission to access information on your GitHub account.

  8. Choose the organization and repositories the app has access to. Your GitHub organizations are enabled by default for your Jira workspace. Optionally, in the Install GitHub Copilot for Jira page, deselect the organization and repositories you don't want the application to have access to.

  9. Click Install.

  10. When installation is complete, you will see a list of connected organizations on the GitHub Copilot for Jira app configuration page in Jira.

Installing the GitHub Copilot for Jira app for GHE.com

  1. Navigate to the GitHub Copilot for Jira (GHEC with Data Residency) installation page on the Atlassian Marketplace.

  2. To the right of the app name, click , and enter your SUBDOMAIN.ghe.com in the text box. Replace SUBDOMAIN with your enterprise's subdomain of GHE.com.

  3. Click Save configuration.

  4. Click Get it now.

  5. Select the Atlassian site you want to install the GitHub application in.

  6. Click Review to check the installation details, and then click Get it now.

    Once GitHub Copilot for Jira is installed in your Jira site, you need to authorize the app to access your GitHub organization and repositories.

  7. Click Configure in the confirmation message in Jira after installation.

    • If you are not automatically redirected, find the GitHub Copilot for Jira app in the list of apps available to your enterprise at SUBDOMAIN.ghe.com/apps/external-app/github-copilot-for-jira. Click Install.
  8. If you are not already logged in to GitHub, click the highlighted Log in to GitHub and follow the prompts to log in to your GitHub account and authorize the application.

    • If your organization or enterprise uses SSO, you may need to start an active SAML session for your organization and perform an additional authorization step.
  9. Click Install app to give the app permission to access information on your GitHub account.

  10. Choose the organization and repositories the app has access to. Your GitHub organizations are enabled by default for your Jira workspace. Optionally, in the Install GitHub Copilot for Jira page, deselect the organization and repositories you don't want the application to have access to.

  11. Click Install.

  12. When installation is complete, you will see a list of connected organizations on the GitHub Copilot for Jira app configuration page in Jira.

Using the GitHub Copilot app in Jira

The Copilot app must be enabled for a GitHub organization you are a member of, before you can start using it.

The first time you use Copilot cloud agent in Jira, you will need to connect it to your GitHub account.

Only users with write access to a repository can trigger Copilot cloud agent to work in that repository.

You can trigger Copilot cloud agent in several ways:

  • Assign GitHub Copilot to a work item using the Assignee field.
  • Mention @GitHub Copilot in a comment on a work item.
  • Use a Jira automation. In your Jira automation rules, select the Use GitHub Copilot action and configure your flow to use a custom trigger based on Jira events, such as when a work item is created or transitioned, or a label is applied. For more information, see Work with AI agents in Jira in the Atlassian documentation.

Note

When you assign Copilot to a Jira work item, the context the agent captures from Jira will be added to the pull request and visible to everyone if the repository is public.

Example: Triggering Copilot cloud agent from a Jira work item

  1. In Jira, open or create a work item that contains clear requirements you want to delegate to Copilot cloud agent.

  2. To specify a repository you want Copilot to work in, mention it in the work item description or in a comment.

  3. Assign GitHub Copilot to the work item, or mention @GitHub Copilot in a comment. For example:

    @GitHub Copilot create a new API endpoint for user authentication in octo-org/octorepo
    
  4. If you have not previously connected the GitHub application in Jira to your GitHub account, follow the prompts to authorize the application for both GitHub and Atlassian.

  5. Once Copilot cloud agent has started working on the pull request, a comment will appear in the chat panel in Jira. The user who initiated the agent session can view progress there.

  6. You can follow up with further instructions for Copilot:

    • Use the Continue in Chat button under the Agents heading to chat directly with Copilot to have updates made to the current pull request.
    • Mention @GitHub Copilot in a comment on the work item to have updates made in a new pull request.

Tip

If you have not received confirmation of triggering Copilot cloud agent after 1 minute, refresh the Jira work item page.

Viewing agent activity in Jira

While cloud agent works its activity streams live into the chat panel in Jira, so you can follow what the agent is doing without leaving your work item. The activity stream includes a link to the associated agent session on GitHub.

Directing Copilot from Jira post-session

When Copilot cloud agent has completed a session, for example when a pull request is ready for review, you can direct Copilot to continue the work:

  • In the chat panel in Jira, select the link to the associated agent session on GitHub. This opens the agents panel on GitHub, where you can review the session and send follow-up instructions to update the existing pull request.
  • Add a follow-up @GitHub Copilot mention or comment on the Jira work item. This starts a new session and opens a new pull request rather than updating the existing one.

Customizing Copilot cloud agent in Jira

You can customize how Copilot cloud agent works in your Jira workspace by specifying models, agents, and custom instructions.

Specifying a model

Specify a model when you want a task to run on a specific model rather than the default. For example, you may choose a lighter model for routine, well-scoped changes. To change the model used by Copilot cloud agent for a particular task, include the model name in your instructions to Copilot, see Changing the AI model for GitHub Copilot cloud agent.

Specifying a custom agent

Specify a custom agent to tailor cloud agent's behavior to a particular workflow or repository. You can specify a custom agent from your GitHub repository directly in the Jira ticket. For more information, see Creating custom agents for Copilot cloud agent.

Using custom instructions

Use custom instructions to set defaults that apply to every session, such as the target repository, so Copilot does not have to pause and ask you for input mid-session. You can define custom instructions at the Jira workspace level that apply every time Copilot cloud agent is triggered.

Usage costs

Copilot cloud agent uses GitHub Actions minutes and AI credits.

For more information, see Usage-based billing for organizations and enterprises.

Adding or removing an organization to the GitHub Copilot for Jira app

A Jira administrator and GitHub organization owner can enable or disable organizations for the integration.

Note

If a new SSO-protected organization is added to the app after the initial installation, users will need to start an active SAML session for the organization in GitHub, in order to trigger Copilot cloud agent to work in the new organization's repositories from Jira. For more information, see About authentication with single sign-on.

To change access for the GitHub Copilot for Jira app for an organization:

  1. In Jira, go to the settings page for your workspace.
  2. Go to the applications setting page for the GitHub Copilot app.
  3. Optionally, click Connect More GitHub Organizations to add new organizations to the list.
  4. Enable or disable the Copilot app for one or more of the listed organizations.

Troubleshooting

If you run into problems, try the following solutions.

You can't see the Copilot cloud agent and it is not possible to assign it to a Jira work item

In Jira, check your Atlassian Administration settings for your organization are set as follows.

  1. Jira is an AI-enabled app, see Activate AI for apps in the Atlassian documentation.

You can see the Copilot cloud agent but it is not possible to assign it to a Jira work item

Check that you have connected your personal account on GitHub to the GitHub Copilot for Jira app.

  1. In Jira, go to the settings page for your personal account.
  2. Under your general settings, select the GitHub Copilot for Jira app.
  3. If you are not already signed in with GitHub, follow the prompts to sign in and authorize the application.

When chatting with GitHub Copilot, you are prompted to sign in

To sign in to GitHub Copilot for Jira app, follow the steps above in You can see the Copilot cloud agent but it is not possible to assign it to a Jira work item.

Other users in your workspace can assign Copilot cloud agent to a Jira work item, but you cannot

If Copilot cloud agent cannot see or work with your organization's resources in Jira and your organization uses SSO in GitHub, you may need to reauthorize the GitHub Copilot for Jira app for your GitHub account. For more information, see About authentication with single sign-on.

To resolve this issue, follow these steps to start a new active SSO session for your organization:

  1. Go to your organization settings in GitHub.
  2. Under "Single sign-on", find the organization you need to authenticate to and click Sign out, and then Sign in.
    • If your enterprise manages SSO for your organization, signing in to one organization in the enterprise works as an SSO session for all organizations in the enterprise.
  3. Return to Jira, and refresh the page you are working in.
  4. Try working with Copilot cloud agent in Jira again.

GitHub Copilot is not responding

Further reading