2. Click `Save application`. You will see the generated 'Application Id' and 'Secret' values.
2. Click `Save application`. You will see the generated 'Application Id' and 'Secret' values.
Copy these values that you will use on the JIRA configuration side.
Copy these values that you will use on the Jira configuration side.
## JIRA Configuration
## Jira Configuration
1. In JIRA, from the gear menu at the top right, go to `Applications`. Navigate to `DVCS accounts`
1. In Jira, from the gear menu at the top right, go to `Applications`. Navigate to `DVCS accounts`
from the left navigation menu. Click `Link GitHub account` to start creating a new integration.
from the left navigation menu. Click `Link GitHub account` to start creating a new integration.
(We are pretending to be GitHub in this integration until there is further platform support from JIRA.)
(We are pretending to be GitHub in this integration until there is further platform support from Jira.)
![JIRA DVCS from Dashboard](img/jira_dev_panel_jira_setup_1.png)
![Jira DVCS from Dashboard](img/jira_dev_panel_jira_setup_1.png)
2. Complete the form
2. Complete the form
...
@@ -77,7 +82,7 @@ from the left navigation menu. Click `Link GitHub account` to start creating a n
...
@@ -77,7 +82,7 @@ from the left navigation menu. Click `Link GitHub account` to start creating a n
For the `Host URL` field, enter `https://<your-gitlab-instance-domain>/`,
For the `Host URL` field, enter `https://<your-gitlab-instance-domain>/`,
replacing `<your-gitlab-instance-domain>` appropriately. So for example, if you are using GitLab.com,
replacing `<your-gitlab-instance-domain>` appropriately. So for example, if you are using GitLab.com,
this would be `https://gitlab.com/`.
this would be `https://gitlab.com/`.
NOTE: **Note**:
NOTE: **Note**:
If using a GitLab version earlier than 11.3 the `Host URL` value should be `https://<your-gitlab-instance-domain>/-/jira`
If using a GitLab version earlier than 11.3 the `Host URL` value should be `https://<your-gitlab-instance-domain>/-/jira`
...
@@ -89,7 +94,7 @@ from the left navigation menu. Click `Link GitHub account` to start creating a n
...
@@ -89,7 +94,7 @@ from the left navigation menu. Click `Link GitHub account` to start creating a n
3. Click `Add` to complete and create the integration.
3. Click `Add` to complete and create the integration.
JIRA takes up to a few minutes to know about (import behind the scenes) all the commits and branches
Jira takes up to a few minutes to know about (import behind the scenes) all the commits and branches
for all the projects in the GitLab group you specified in the previous step. These are refreshed
for all the projects in the GitLab group you specified in the previous step. These are refreshed
every 60 minutes.
every 60 minutes.
...
@@ -98,28 +103,34 @@ from the left navigation menu. Click `Link GitHub account` to start creating a n
...
@@ -98,28 +103,34 @@ from the left navigation menu. Click `Link GitHub account` to start creating a n
> to refresh the data manually, you can do this from the `Applications -> DVCS
> to refresh the data manually, you can do this from the `Applications -> DVCS
> accounts` screen where you initially set up the integration:
> accounts` screen where you initially set up the integration:
>
>
> ![Refresh GitLab information in JIRA](img/jira_dev_panel_manual_refresh.png)
> ![Refresh GitLab information in Jira](img/jira_dev_panel_manual_refresh.png)
To connect additional GitLab projects from other GitLab top-level groups (or personal namespaces), repeat the above
To connect additional GitLab projects from other GitLab top-level groups (or personal namespaces), repeat the above
steps with additional JIRA DVCS accounts.
steps with additional Jira DVCS accounts.
You may now refer any Jira issue by its ID in branch names, commit messages and merge request names on GitLab's side,
You may now refer any Jira issue by its ID in branch names, commit messages and merge request names on GitLab's side,
and you will be able to see the linked `branches`, `commits`, and `merge requests` when entering a JIRA issue
and you will be able to see the linked `branches`, `commits`, and `merge requests` when entering a Jira issue
(inside the Jira issue, merge requests will be called "pull requests").
(inside the Jira issue, merge requests will be called "pull requests").
![Branch, Commit and Pull Requests links on Jira issue](img/jira_dev_panel_jira_setup_3.png)
![Branch, Commit and Pull Requests links on JIRA issue](img/jira_dev_panel_jira_setup_3.png)
Click the links to see your GitLab repository data.
Click the links to see your GitLab repository data.
![GitLab commits details on a JIRA issue](img/jira_dev_panel_jira_setup_4.png)
![GitLab commits details on a Jira issue](img/jira_dev_panel_jira_setup_4.png)
![GitLab merge requests details on a JIRA issue](img/jira_dev_panel_jira_setup_5.png)
![GitLab merge requests details on a Jira issue](img/jira_dev_panel_jira_setup_5.png)
## Limitations
## Limitations
- This integration is currently not supported on GitLab instances under a [relative url][relative-url] (e.g. `http://example.com/gitlab`).
- This integration is currently not supported on GitLab instances under a [relative url][relative-url] (e.g. `http://example.com/gitlab`).
- The GitLab user that you use to configure this integration must be a member of all
projects you wish to link to Jira. We're investigating removing this limitation in in [a feature proposal](https://gitlab.com/gitlab-org/gitlab-ee/issues/8902).
## Changelog
### 11.1
-[Support GitLab subgroups in Jira development panel](https://gitlab.com/gitlab-org/gitlab-ee/issues/3561)