debian-mirror-gitlab/doc/integration/jira/dvcs/index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

78 lines
4.5 KiB
Markdown
Raw Normal View History

2021-04-29 21:17:54 +05:30
---
2022-11-25 23:54:43 +05:30
stage: Manage
2023-07-09 08:55:56 +05:30
group: Import and Integrate
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-04-29 21:17:54 +05:30
---
2021-06-08 01:23:25 +05:30
# Jira DVCS connector **(FREE)**
2021-04-29 21:17:54 +05:30
2023-06-20 00:43:36 +05:30
WARNING:
The Jira DVCS connector for Jira Cloud was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/362168) in GitLab 15.1
2023-07-09 08:55:56 +05:30
and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/118126) in 16.0. Use the [GitLab for Jira Cloud app](../connect-app.md) instead.
The Jira DVCS connector was also deprecated and removed for Jira 8.13 and earlier. You can only use the Jira DVCS connector with Jira Data Center or Jira Server in Jira 8.14 and later. Upgrade your Jira instance to Jira 8.14 or later, and reconfigure the Jira integration in your GitLab instance.
2023-06-20 00:43:36 +05:30
2021-04-29 21:17:54 +05:30
Use the Jira DVCS (distributed version control system) connector if you self-host
2023-07-09 08:55:56 +05:30
your Jira instance with Jira Data Center or Jira Server and want to use the [Jira development panel](../development_panel.md).
2021-04-29 21:17:54 +05:30
2023-07-09 08:55:56 +05:30
If you're on Jira Cloud, migrate to the GitLab for Jira Cloud app. For more information, see [Install the GitLab for Jira Cloud app](../connect-app.md#install-the-gitlab-for-jira-cloud-app).
2021-04-29 21:17:54 +05:30
2023-07-09 08:55:56 +05:30
## Configure the Jira DVCS connector
2023-03-04 22:38:38 +05:30
2023-07-09 08:55:56 +05:30
### Prerequisites
2021-04-29 21:17:54 +05:30
2023-07-09 08:55:56 +05:30
- Your GitLab instance must be accessible by Jira.
- You must have at least the Maintainer role for the GitLab group.
- Your network must allow inbound and outbound connections between GitLab and Jira.
2021-04-29 21:17:54 +05:30
2023-07-09 08:55:56 +05:30
### Create a GitLab application for DVCS
2021-04-29 21:17:54 +05:30
2023-07-09 08:55:56 +05:30
- **For projects in a single group**, you should create a [group application](../../oauth_provider.md#create-a-group-owned-application).
- **For projects across multiple groups**, you should create a separate GitLab user account for Jira integration work only.
This account ensures regular maintenance does not affect your integration.
- **If you cannot create a group application or separate user account**, you can create instead:
- [An instance-wide application](../../oauth_provider.md#create-an-instance-wide-application)
- [A user-owned application](../../oauth_provider.md#create-a-user-owned-application)
2021-04-29 21:17:54 +05:30
2023-07-09 08:55:56 +05:30
To create a GitLab application for DVCS:
2023-06-20 00:43:36 +05:30
1. Go to the [appropriate **Applications** section](../../oauth_provider.md).
1. In the **Name** text box, enter a descriptive name for the integration (for example, `Jira`).
1. In the **Redirect URI** text box, enter the generated **Redirect URL** from
[linking GitLab accounts](https://confluence.atlassian.com/adminjiraserver/linking-gitlab-accounts-1027142272.html).
1. In **Scopes**, select `api` and clear any other checkboxes.
2023-07-09 08:55:56 +05:30
The Jira DVCS connector requires a **write-enabled** `api` scope to automatically create and manage required webhooks.
2021-04-29 21:17:54 +05:30
1. Select **Submit**.
2021-12-11 22:18:48 +05:30
1. Copy the **Application ID** and **Secret** values.
2023-06-20 00:43:36 +05:30
You need these values to configure Jira.
2021-04-29 21:17:54 +05:30
2023-07-09 08:55:56 +05:30
### Configure Jira for DVCS
2021-04-29 21:17:54 +05:30
2023-07-09 08:55:56 +05:30
To configure Jira for DVCS:
2021-04-29 21:17:54 +05:30
2023-07-09 08:55:56 +05:30
1. Go to your DVCS account. **For Jira Server**, select **Settings (gear) > Applications > DVCS accounts**.
2023-06-20 00:43:36 +05:30
1. To create a new integration, for **Host**, select **GitLab** or **GitLab Self-Managed**.
2023-07-09 08:55:56 +05:30
1. For **Team or User Account**, enter the relative path of a top-level GitLab group that [the GitLab user](#create-a-gitlab-application-for-dvcs) can access.
2023-06-20 00:43:36 +05:30
1. In the **Host URL** text box, enter the appropriate URL.
Replace `<gitlab.example.com>` with your GitLab instance domain.
Use `https://<gitlab.example.com>`.
2023-07-09 08:55:56 +05:30
1. For **Client ID**, use the [**Application ID** value](#create-a-gitlab-application-for-dvcs).
1. For **Client Secret**, use the [**Secret** value](#create-a-gitlab-application-for-dvcs).
2023-06-20 00:43:36 +05:30
1. Ensure that all other checkboxes are selected.
2023-07-09 08:55:56 +05:30
1. To create the DVCS account, select **Add**, then **Continue**.
Jira redirects to GitLab where you have to confirm the authorization. GitLab then redirects back to Jira
where the synced projects are displayed in the new account. The initial sync takes a few minutes.
After the initial sync, it can take up to 60 minutes to refresh.
2021-04-29 21:17:54 +05:30
2021-12-11 22:18:48 +05:30
To connect additional GitLab projects from other GitLab top-level groups or
2021-04-29 21:17:54 +05:30
personal namespaces, repeat the previous steps with additional Jira DVCS accounts.
## Refresh data imported to Jira
2023-07-09 08:55:56 +05:30
Jira imports commits and branches for GitLab projects every 60 minutes. To refresh the data manually in Jira:
2021-04-29 21:17:54 +05:30
1. Sign in to your Jira instance as the user you configured the integration with.
1. Go to **Settings (gear) > Applications**.
1. Select **DVCS accounts**.
2023-07-09 08:55:56 +05:30
1. In the **Last activity** column, next to the repository you want to refresh, select **Refresh** (**{retry}**).