Quickstart: Using Jira issues in CodeCatalyst
Perform the following steps to install the Jira Software extension, connect your Jira sites to your CodeCatalyst spaces, and link your Jira projects to your CodeCatalyst projects.
Contents
Step 1: Install the Jira Software extension from the CodeCatalyst catalog
The first step to managing Jira in CodeCatalyst is to install the Jira Software extension from the CodeCatalyst catalog. To install the extension, perform the following steps, choosing the Jira Software extension.
Important
As part of installing and configuring the Jira Software extension, you must have an Atlassian account and an existing Jira site, but a Jira project can be created at a later time. You must be the Jira site administrator and the CodeCatalyst Space administrator.
To install an extension from the CodeCatalyst catalog
Open the CodeCatalyst console at https://codecatalyst.aws/
. Navigate to your CodeCatalyst space.
Navigate to the CodeCatalyst CodeCatalyst catalog by choosing the Catalog icon
in the top menu. You can search for Jira Software or
filter extensions based on categories.-
(Optional) To see more details about the extension, such as the permissions the extension will have, choose the Jira Software extension name.
Choose Install. Review the permissions required by the extension, and if you want to continue, choose Install again.
After installing the Jira Software extension, you are taken to the Jira Software extension details page, where you can view and manage connected Jira sites and linked Jira projects.
Step 2: Connect your Jira sites to your CodeCatalyst space
After you install the Jira Software extension, the next step is to connect your Jira site to your CodeCatalyst space.
Important
To connect your Jira site to your CodeCatalyst space, you must be both the Jira site administrator and the CodeCatalyst Space administrator.
To connect your Jira site to CodeCatalyst
In the Connected Jira sites tab, choose Connect Jira site to go to the external site for Atlassian Marketplace.
Choose Get it now to get started with installing CodeCatalyst on your Jira site.
Depending on your role, do one of the following:
-
If you are a Jira site administrator, from the site drop-down menu, choose the Jira site to install the CodeCatalyst application, and then choose Install app.
Note
If you have one Jira site, this step won't appear, and you'll automatically be directed to the next step.
-
If you aren't a Jira administrator, from the site drop-down menu, choose the Jira site to install the CodeCatalyst application, and then choose Request app.
Enter the reason you need to install CodeCatalyst into the input text field or keep the default text, and then choose Submit request.
-
Review the actions performed by CodeCatalyst when the application is installed, and then choose Get it now.
After the application is installed, choose Return to CodeCatalyst to return to CodeCatalyst.
After connecting your Jira site to CodeCatalyst, you can view the connected site in the Connected Jira sites tab of the Jira Software extension details page.
Step 3: Link your Jira project to your CodeCatalyst project
The third step to managing your Jira project in CodeCatalyst is to link the Jira project to the CodeCatalyst project in which you want to use it.
Note
A CodeCatalyst project can only be linked to one Jira project. A Jira project can be linked to multiple CodeCatalyst projects.
Important
To link your Jira project to your CodeCatalyst project, you must be the CodeCatalyst Space administrator or CodeCatalyst Project administrator.
To link a Jira project to a CodeCatalyst project from the Jira Software extension details page
In the Linked Jira projects tab, choose Link Jira project.
From the Jira site drop-down menu, choose the Jira site that contains the project that you want to link.
From the Jira project drop-down menu, choose the project you want to link to a CodeCatalyst project.
From the CodeCatalyst project drop-down menu, choose the CodeCatalyst project you want to link to a Jira project.
Choose Link.
Once a Jira project is linked to a CodeCatalyst project, access to CodeCatalyst issues is disabled entirely, and Issues in the CodeCatalyst navigation pane will be replaced with a Jira issues item that links to the Jira project.
Step 4: Linking your Jira issues to a CodeCatalyst pull request
After linking a Jira project to CodeCatalyst project, you can link CodeCatalyst issues by creating a pull request and have them displayed as a property of the pull request.
Note
You can't create a pull request without a source repository with two branches in your CodeCatalyst project. For more information on pull requests, see Working with pull requests in CodeCatalyst.
To link Jira issues to a CodeCatalyst pull request
-
In the navigation pane, choose Code, and then choose Pull requests.
-
Choose Create pull request to enter the pull request details.
-
From the Source repository drop-down menu, choose the source repository in which you want to link a pull request.
-
From the Source branch drop-down menu, choose the branch that contains the changes you want reviewed.
-
From the Destination branch drop-down menu, choose the branch where you want to merge reviewed changes.
-
In the Pull request title text input field, enter the title of your pull requests.
-
Choose Link issues for the Jira issues - optional field, choose the drop-down, and search the Jira issues you want to add from the linked Jira project.
-
Select the Jira issues you want to add to the pull request.
-
Choose Create to create the pull request.
The summary status of the pull request and the status of associated CodeCatalyst workflow events are reflected in your Jira issue.
Next steps
After installing the Jira Software extension, connecting your Jira site, linking your Jira projects to your CodeCatalyst project, and linking a pull request, updates from CodeCatalyst are reflected in your Jira project. For more information on viewing CodeCatalyst events in Jira, see Viewing CodeCatalyst events in Jira.
