|
3 | 3 | :description: Connecting Jira with CircleCI
|
4 | 4 | :experimental:
|
5 | 5 |
|
6 |
| -Integrate your CI/CD build and deployment status notifications directly into your Jira cards. Connect your CircleCI jobs with Jira Cloud using the following: |
| 6 | +Integrate your CI/CD build and deployment status notifications directly into your Jira cards. |
7 | 7 |
|
8 |
| -* The link:https://marketplace.atlassian.com/apps/1215946/circleci-for-jira[CircleCI for Jira] Atlassian Forge application |
9 |
| -* The link:https://circleci.com/developer/orbs/orb/circleci/jira[`circleci/jira`] orb |
| 8 | +Connect your CircleCI jobs with Jira Cloud using: |
| 9 | + |
| 10 | +* The *CircleCI for Jira* app from the link:https://marketplace.atlassian.com/apps/1215946/circleci-for-jira[Atlassian Marketplace] |
| 11 | +* The `circleci/jira` orb from the link:https://circleci.com/developer/orbs/orb/circleci/jira[CircleCI orbs registry] |
10 | 12 |
|
11 | 13 | [#installation-steps]
|
12 | 14 | == Installation steps
|
13 | 15 |
|
14 | 16 | [#install-the-circleci-for-jira-app]
|
15 | 17 | === Install the CircleCI for Jira app
|
16 | 18 |
|
17 |
| -. Install the link:https://marketplace.atlassian.com/apps/1215946/circleci-for-jira[CircleCI for Jira] app from the Atlassian Marketplace in the appropriate Jira Cloud instance. To do this you must be a link:https://support.atlassian.com/jira-software-cloud/docs/manage-atlassian-marketplace-apps-in-team-managed-projects/[Jira Admin] |
| 19 | +. Go to the Atlassian Marketplace to install the link:https://marketplace.atlassian.com/apps/1215946/circleci-for-jira[CircleCI for Jira] app. |
| 20 | ++ |
| 21 | +image::guides:ROOT:jira_circleci_app.png[CircleCI for Jira app in Atlassian Marketplace] |
| 22 | + |
| 23 | +. Install the app in the appropriate Jira Cloud instance. To do this, you must be a link:https://support.atlassian.com/jira-software-cloud/docs/manage-atlassian-marketplace-apps-in-team-managed-projects/[Jira Admin]. |
18 | 24 | +
|
19 |
| -image::guides:ROOT:jira_install_app.png[Select organization and confirm app installation] |
| 25 | +image::guides:ROOT:jira_install_app.png[Select organization] |
| 26 | ++ |
| 27 | +image::guides:ROOT:jira_review_install.png[Review and confirm app installation] |
| 28 | + |
| 29 | +. Navigate to the link:https://confluence.atlassian.com/upm/viewing-installed-apps-273875714.html[configuration page] by following these steps: |
| 30 | +.. Go to link:https://admin.atlassian.com/[the Atlassian admin page]. |
| 31 | +.. Ensure you have selected the appropriate organization (if you have more than one), and then select menu:Products[]. |
| 32 | +.. For the appropriate Jira instance, select the ellipsis (image:guides:ROOT:icons/more.svg[more icon, role="no-border"]) icon. |
| 33 | +.. In the contextual menu, select menu:Manage Jira apps[]. |
20 | 34 |
|
21 |
| -. Navigate to the link:https://confluence.atlassian.com/upm/viewing-installed-apps-273875714.html[configuration page]. To find the configuration page, navigate to link:https://admin.atlassian.com/[`admin.atlassian.com`], select the appropriate organization, and then on the appropriate Jira instance, click the three-dot menu, and then click *Manage Jira apps*. |
22 | 35 | +
|
23 | 36 | image::guides:ROOT:jira_manage_apps.png[manage apps menu]
|
24 | 37 |
|
25 | 38 | . From the *Manage apps* page, click on the *CircleCI for Jira* app under *User-installed apps* to expand the app details and click *Configure*.
|
26 | 39 | +
|
27 | 40 | image::guides:ROOT:jira_expand_app_details.png[Expand App Details]
|
28 | 41 |
|
29 |
| -. To display the app fully, it is essential that you grant it permission to access Atlassian products on your behalf. Click *Allow access* to authorize. |
| 42 | +. Provide your CircleCI Organization ID and allowed audiences. |
30 | 43 | +
|
31 |
| -image::guides:ROOT:jira_allow_app_access.png[Allow the app access to Atlassian on your behalf] |
| 44 | +[NOTE] |
| 45 | +==== |
| 46 | +Your CircleCI Organization ID is only needed for the initial setup. You can find it by navigating to menu:Organization Settings[Overview] in the https://app.circleci.com/[CircleCI web app]. |
32 | 47 |
|
33 |
| -. For the initial setup you will need to provide your CircleCI Organization ID, which you can find by navigating to menu:Organization Settings[Overview] in the https://app.circleci.com/[CircleCI application]. |
34 |
| -+ |
35 |
| -image::guides:ROOT:jira_get_org_id.png[Get CircleCI Organization ID] |
36 |
| - |
37 |
| -. This integration authenticates via xref:permissions-authentication:openid-connect-tokens.adoc[OpenID Connect (OIDC)]. By default, the organization ID provided is used for audience validation, but this can be modified, or more can be added. |
38 |
| - |
39 |
| -. Once you have provided your CircleCI Organization ID and optionally modified the allowed audiences, click *Submit* to save your changes. |
| 48 | +This integration authenticates via xref:permissions-authentication:openid-connect-tokens.adoc[OpenID Connect (OIDC)]. By default, the organization ID provided is used for audience validation, but this can be modified, or more can be added. |
| 49 | +==== |
40 | 50 | +
|
41 | 51 | image::guides:ROOT:jira_set_organization_id.png[Set the Organization ID on the app Configure page]
|
42 | 52 |
|
43 |
| -. Now copy your *Webhook URL* for use in the next section. |
| 53 | +[start=6] |
| 54 | +. Select *Submit* to save your changes. |
| 55 | ++ |
| 56 | +image::guides:ROOT:jira_submit_changes.png[Set the Organization ID on the app Configure page] |
| 57 | +. Now copy your *Web Trigger URL* for use in the next section. |
44 | 58 | +
|
45 |
| -image::guides:ROOT:jira_copy_webtrigger_url.png[Click on button to copy the Webtrigger URL] |
| 59 | +image::guides:ROOT:jira_copy_webtrigger_url.png[Copy the Webtrigger URL] |
46 | 60 |
|
47 | 61 | [#configure-the-jira-orb]
|
48 | 62 | === Configure the Jira orb
|
49 | 63 |
|
50 | 64 | The link:https://circleci.com/developer/orbs/orb/circleci/jira[`circleci/jira`] orb is responsible for relaying information about your build or deployment to the CircleCI Jira application.
|
51 | 65 |
|
52 |
| -. Begin by saving the *Webhook URL* from the previous section as an _environment variable_. This could be added as a xref:security:set-environment-variable.adoc#set-an-environment-variable-in-a-project[Project Environment Variable] or within a xref:security:set-environment-variable.adoc#set-an-environment-variable-in-a-context[Context]. We recommend naming the variable `JIRA_WEBHOOK_URL`. |
| 66 | +. Begin by saving the *Web Trigger URL* from the previous section as an _environment variable_. This could be added as a xref:security:set-environment-variable.adoc#set-an-environment-variable-in-a-project[Project Environment Variable] or within a xref:security:set-environment-variable.adoc#set-an-environment-variable-in-a-context[Context]. We recommend naming the variable `JIRA_WEBHOOK_URL`. |
53 | 67 |
|
54 | 68 | . Next, import the Jira orb into your `.circleci/config.yml` file and implement the `jira/notify` command at the _end_ of your build and deployment jobs. Detailed and up-to-date configuration examples can be found on the link:https://circleci.com/developer/orbs/orb/circleci/jira#usage-examples[orb page].
|
55 | 69 |
|
|
0 commit comments