Jira Integration: Hyperlinks to Jira Issues in Merge Requests and more

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Terminology

  • Jira Issue Key - unique ticket identifier in Jira (e.g. PRJ-237)
  • Jira Issue Link - hyperlink pointing to the external organization Jira URL (configured as Web URL in GitLab project's Jira Integration settings) and leading directly to the web page describing particular Jira Issue (e.g. https://example.org/browse/PRJ-237)

Summary

There are following items to be reviewed here:

  • 📖 Item №1 - Documentation: maybe I am missing something, but it is not clear how much time need to wait after (re-)configuring and activating Jira Integration for all Jira Issue Links to be initialized/updated (even after waiting for more than 17 hours some Jira Issue Keys are still not parsed on Commits page / or URLs still pointing to the old hostname)
  • 🐛 Item №2 - Merge Requests: Jira Issue Links seems to be not updating in Merge Request after changing Web URL in GitLab project's Jira Integration settings and I have not found any way to force removing or updating them (once Merge Request is created and Jira Issue Links are initialized in it - they are never updated, regardless of how Jira Integration settings are changed)
  • ⭐ Item №3 - Merge Requests: Jira Issue Keys are not parsed on Merge Requests page (likely looks more like feature request, but once Jira Integration is configured for the project, it is supposed, I guess, that Jira Issue Links are present in as many places as possible, meanwhile this doesn't work for Merge Requests page)

Steps to reproduce

Initial Setup: GitLab project never had Jira Integration enabled (all fields are empty on Project Settings > Integrations > Jira page)

  1. Go to Project Settings > Integrations > Jira
  2. Fill the form: set Active checkbox, type in Web URL (with "hostname-1"), Username, Password, click Save
    Gitlab-Jira-integration-state-1
  3. Go to Repository > Commits, check if Jira Issue Keys are parsed in the Commit messages and Jira Issue Links are pointing to the right pages
  4. Create some Merge Requests having Jira Issue Keys in the title
  5. Go to Merge Requests > All (or filter with Open/Merged/Closed), check if Jira Issue Keys are parsed in the titles
  6. Click on any Merge Request having at least one Jira Issue Key in the title, check if Jira Issue Key(s) are parsed in the title
  7. Go to Project Settings > Integrations > Jira
  8. Change settings: move Web URL (with "hostname-1") value into Jira API URL field, type in new value for Web URL (with "hostname-2"), click Save
    Gitlab-Jira-integration-state-2
  9. Repeat Steps 3, 4, 5, 6 several times for various branches, Merge Requests and after various amount of time since changing Jira Integration settings

What is the current bug behavior?

  1. OK
  2. OK
  3. Only some Jira Issue Keys are parsed in the Commit messages, and those which parsed - are pointing to "hostname-1" URL
    • sign of 📖 Item №1, I'm not sure if it is OK, I just expect it to work immediately
  4. OK
  5. Jira Issue Keys are not parsed in the titles
    • sign of ⭐ Item №3
      Gitlab-Jira-integration-Merge-requestS
  6. Jira Issue Keys are parsed in the title and pointing to "hostname-1" URL
    • potentially can suffer of the same 📖 Item №1, but I don't remember exactly
  7. OK
  8. OK
  9. As per each item:
  • Commits (Step 3): Only some Jira Issue Links are pointing to "hostname-2" URL, the rest are still pointing to old "hostname-1" URL
    • again, sign of 📖 Item №1
    • After some unknown time, seems to be going to normal (all links pointing to new "hostname-2" URL), but even after 20 hours old links still can be observed
      Gitlab-Jira-integration-Commits1
      Gitlab-Jira-integration-Commits2
  • Merge Requests (Step 5): Nothing is never parsed in the titles
    • this is what ⭐ Item №3 all about (see screenshot from Step 5 above)
  • Merge Request (Step 6): Jira Issue Links in new Merge Requests are pointing to new "hostname-2" URL, but those Merge Requests already opened before integration settings change - still pointing to old "hostname-1" URL
    • sign of 🐛 Item №2. It is not going away with time.
      Gitlab-Jira-integration-Merge-request

What is the expected correct behavior?

  1. OK
  2. OK
  3. All Jira Issue Keys are parsed in the Commit messages for all branches and pointing to "hostname-1" URL (OR it is crystal clear how much time I need to wait for this to happen).
  4. OK
  5. All Jira Issue Keys are parsed in the titles and pointing to "hostname-1" URL (OR it is crystal clear how much time I need to wait for this to happen).
  6. OK
  7. OK
  8. OK
  9. As per each item:
  • Commits (Step 3): All Jira Issue Keys are parsed in the Commit messages for all branches and pointing to new "hostname-2" URL (OR it is crystal clear how much time I need to wait for this to happen).
  • Merge Requests (Step 5): All Jira Issue Keys are parsed in the Merge Requests titles and pointing to new "hostname-2" URL (OR it is crystal clear how much time I need to wait for this to happen).
  • Merge Request (Step 6): Jira Issue Links are pointing to new "hostname-2" URL in ALL Merge Requests (new and existing) (OR it is crystal clear how much time I need to wait for this to happen).

Relevant logs and/or screenshots

Screenshots already provided in the sections above.

Output of checks

This bug happens on GitLab.com.

Possible fixes

I believe this should be quite obvious and plain solutions.

  • 📖 Item №1 - Update documentation and state how much time it is required to wait for all links to be initialized/updated everywhere (Commits, Merge Requests, etc...)
  • 🐛 Item №2 - For Merge Request page - implement the same mechanism of links updating that is used for Commits
  • ⭐ Item №3 - For Merge Requests list page - implement the same mechanism of links parsing that is used for Commits
Edited by 🤖 GitLab Bot 🤖