GitLab Jira integration · Gitlab 中文文檔

# GitLab Jira integration > 原文：[https://docs.gitlab.com/ee/user/project/integrations/jira.html](https://docs.gitlab.com/ee/user/project/integrations/jira.html) * [Configuration](#configuration) * [Configuring Jira](#configuring-jira) * [Jira Server](#jira-server) * [Jira Cloud](#jira-cloud) * [Configuring GitLab](#configuring-gitlab) * [Obtaining a transition ID](#obtaining-a-transition-id) * [Disabling comments on Jira issues](#disabling-comments-on-jira-issues) * [Jira issues](#jira-issues) * [Referencing Jira Issues](#referencing-jira-issues) * [Closing Jira Issues](#closing-jira-issues) * [Jira issue closing example](#jira-issue-closing-example) * [Troubleshooting](#troubleshooting) * [GitLab is unable to comment on a Jira issue](#gitlab-is-unable-to-comment-on-a-jira-issue) * [GitLab is unable to close a Jira issue](#gitlab-is-unable-to-close-a-jira-issue) * [CAPTCHA](#captcha) # GitLab Jira integration[](#gitlab-jira-integration "Permalink") GitLab 問題是討論想法，計劃和跟蹤工作的強大工具. 但是，許多組織已經將 Jira 用于這些目的，并且內置了廣泛的數據和業務流程. 盡管您始終可以將內容和流程從 Jira 遷移到 GitLab Issue，但是您也可以選擇繼續使用 Jira，并通過我們的集成將其與 GitLab 一起使用. 有關與 Jira 集成的視頻演示，請觀看有關[GitLab 工作流程的 Jira 問題和 Jenkins 管道](https://youtu.be/Jn-_fyra7xQ) . 將 GitLab 項目與 Jira 實例集成后，即可自動檢測 GitLab 項目與 Jira 中的任何項目之間的活動并進行交叉引用. 這包括在 GitLab 中完成工作后關閉或轉換 Jira 問題的功能. 在 GitLab 中執行以下操作時，集成的響應方式如下： * 在提交消息或 MR（合并請求）中**提及 Jira 問題 ID** . * GitLab 超鏈接至 Jira 問題. * Jira 問題將問題鏈接添加到 GitLab 中的提交/ MR. * Jira 問題會添加評論，以反映在 GitLab 中發表的評論，評論作者以及在 GitLab 中指向 commit / MR 的鏈接，除非[禁用了](#disabling-comments-on-jira-issues)對 Jira 的評論. * **提及提交或 MR"關閉"，"解決"或"修復" Jira 問題 ID** . 在項目的默認分支（通常是主分支）上進行提交或將更改合并到默認分支時： * GitLab 的合并請求頁面顯示一條注釋，指出"已關閉" Jira 問題，并帶有指向該問題的鏈接. （注意：在合并之前，MR 將顯示它"關閉"了 Jira 問題.） * Jira 問題顯示活動，并且 Jira 問題已關閉或已轉換. 您還可以直接從 GitLab 使用[Jira 的 Smart](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html) Commit，如文章[如何以及為什么將 GitLab 與 Jira 集成中所述](https://www.programmableweb.com/news/how-and-why-to-integrate-gitlab-jira/how-to/2017/04/25) . ## Configuration[](#configuration "Permalink") 每個 GitLab 項目都可以配置為連接到整個 Jira 實例. 這意味著一個 GitLab 項目一旦配置，便可以與該實例中的*所有* Jira 項目進行交互. 因此，您不必將 GitLab 項目與任何單個 Jira 項目顯式關聯. 如果您有一個 Jira 實例，則可以使用默認模板預先填充設置頁面. 請參閱[服務模板](services_templates.html)文檔. 為了在 GitLab 中啟用 Jira 服務，您需要首先在 Jira 中配置項目，然后在 GitLab 中輸入正確的值. ### Configuring Jira[](#configuring-jira "Permalink") #### Jira Server[](#jira-server "Permalink") **Jira Server**支持基本身份驗證. 連接時，需要**用戶名和密碼** . 請注意，無法通過 CAS 連接到 Jira Server. 首先[在 Jira Server 中設置用戶，](jira_server_configuration.html)然后繼續[配置 GitLab](#configuring-gitlab) . #### Jira Cloud[](#jira-cloud "Permalink") **Jira Cloud**支持通過 API 令牌進行身份驗證. 連接到**Jira Cloud 時** ，需要**電子郵件和 API 令牌** . 首先[在 Jira Cloud 中設置用戶，](jira_cloud_configuration.html)然后繼續[配置 GitLab](#configuring-gitlab) . ### Configuring GitLab[](#configuring-gitlab "Permalink") > **Notes:** > > * 當前支持的 Jira 版本是`v6.x, v7.x, v8.x` . 需要 GitLab 7.8 或更高版本. > * GitLab 8.14 引入了一種與 Jira 集成的新方法，該方法大大簡化了您必須輸入的配置選項. 如果您使用的是舊版本，請[遵循此文檔](https://gitlab.com/gitlab-org/gitlab/blob/8-13-stable-ee/doc/project_services/jira.md) . > * 為了支持 Oracle 的 Access Manager，GitLab 將發送其他 cookie 以啟用基本身份驗證. 添加到每個請求的 cookie 是`OBBasicAuth` ，其值為`fromDialog` . 要在項目中啟用 Jira 集成，請導航到[Integrations 頁面](overview.html#accessing-integrations) ，單擊**Jira**服務，然后按照下表中的說明在頁面上填寫所需的詳細信息. | Field | Description | | --- | --- | | `Web URL` | 鏈接到此 GitLab 項目的 Jira 實例 Web 界面的基本 URL. 例如， `https://jira.example.com` . | | `Jira API URL` | The base URL to the Jira instance API. Web URL value will be used if not set. E.g., `https://jira-api.example.com`. Leave this field blank (or use the same value of `Web URL`) if using **吉拉云**. | | `Username/Email` | 在[配置 Jira step](#configuring-jira)時創建. 將`username`用于**Jira Server**或將`email`用于**Jira Cloud** . | | `Password/API token` | 在[配置 Jira 步驟中](#configuring-jira)創建. 為**Jira Server**使用`password`或為**Jira Cloud**使用`API token` . | | `Transition ID` | 這是將問題移至所需狀態的過渡的 ID. 它可以插入過渡 IDS 分離通過`,`或`;` 這意味著將按照給定的順序將問題逐個移至每個州. **如果您未正確設置 ID，則無法通過提交或合并請求來關閉 Jira 問題.** | ### Obtaining a transition ID[](#obtaining-a-transition-id "Permalink") 在最新的 Jira 用戶界面中，您不再可以在工作流管理 UI 中看到過渡 ID. 您可以通過以下兩種方式之一獲取所需的 ID： 1. 通過使用 API??，并使用諸如處于適當"打開"狀態的問題的請求（例如`https://yourcompany.atlassian.net/rest/api/2/issue/ISSUE-123/transitions` 2. 通過將鼠標懸停在所需轉換的鏈接上并在 URL 中查找" action"參數請注意，即使您要更改的狀態相同，過渡 ID 在工作流之間也可能有所不同（例如，錯誤與故事）. 保存配置后，您的 GitLab 項目將能夠與 Jira 實例中的所有 Jira 項目進行交互，并且您將在 GitLab 項目頁面上看到 Jira 鏈接，該鏈接將您帶到適當的 Jira 項目. [![Jira service page](https://img.kancloud.cn/af/b7/afb731ec6794bd5544527b09c38e6595.png)](img/jira_service_page_v12_2.png) ### Disabling comments on Jira issues[](#disabling-comments-on-jira-issues "Permalink") 當您引用 Jira 問題時，它將始終鏈接回 GitLab 中的源提交/ MR，但是，您可以控制 GitLab 是否還將交叉發布對 Jira 問題的評論. 默認情況下啟用該功能. 要禁用對 Jira 問題的自動評論： 1. 打開" [集成"頁面，](overview.html#accessing-integrations)然后選擇**Jira** . 2. 在" **事件操作"**部分中，取消選中" **注釋"** . ## Jira issues[](#jira-issues "Permalink") 現在，您應該已經[配置了 Jira](#configuring-jira)并[在 GitLab 中](#configuring-gitlab)啟用了[Jira 服務](#configuring-gitlab) . 如果一切設置正確，您應該能夠通過在 GitLab 提交和合并請求中提及 ID 來引用和關閉 Jira 問題. ### Referencing Jira Issues[](#referencing-jira-issues "Permalink") 當 GitLab 項目配置并啟用了 Jira 問題跟蹤器時，在 GitLab 中提及 Jira 問題將自動在 Jira 問題中添加評論，并帶有返回到 GitLab 的鏈接. 這意味著在合并請求和提交中引用問題的注釋中，例如`PROJECT-7` ，將在 Jira issue 中添加以下格式的注釋： ``` USER mentioned this issue in RESOURCE_NAME of [PROJECT_NAME|LINK_TO_COMMENT]: ENTITY_TITLE ``` * `USER`提到問題的用戶. 這是指向 GitLab 中的用戶配置文件的鏈接. * `LINK_TO_THE_COMMENT`鏈接到提及的來源，帶有提及吉拉問題的實體的名稱. * `RESOURCE_NAME`引用該問題的`RESOURCE_NAME`種類. 可以是提交或合并請求. * `PROJECT_NAME` GitLab 項目名稱. * `ENTITY_TITLE`合并請求標題或提交消息的第一行. [![example of mentioning or closing the Jira issue](https://img.kancloud.cn/db/86/db86c61d910114b2116ac66b55e0d96f_764x467.png)](img/jira_issue_reference.png) 例如，以下提交將引用以`PROJECT-1`作為 ID 的 Jira 問題： ``` git commit -m "PROJECT-1 Fix spelling and grammar" ``` ### Closing Jira Issues[](#closing-jira-issues "Permalink") 通過在提交和合并請求中使用觸發詞，可以直接從 GitLab 關閉 Jira 問題. 當推送包含觸發詞并在提交消息中包含 Jira 問題 ID 的提交時，GitLab 將在提到的 Jira 問題中添加注釋，并立即將其關閉（前提是正確設置了轉換 ID）. 當前有三個觸發詞，您可以使用其中一個來實現相同的目標： * `Resolves PROJECT-1` * `Closes PROJECT-1` * `Fixes PROJECT-1` 其中`PROJECT-1`是 Jira 問題的 ID. > **Notes:** > > * 只有提交并合并到項目的默認分支（通常是**master** ）才能關閉 Jira 中的問題. 您可以在[項目設置](img/jira_project_settings.png)下更改項目默認分支. > * 如果有解決方案，那么 Jira 問題將不會過渡. ### Jira issue closing example[](#jira-issue-closing-example "Permalink") 讓我們考慮以下示例： 1. 對于 Jira 中名為`PROJECT` ，我們實現了一項新功能，并在 GitLab 中創建了合并請求. 2. This feature was requested in Jira issue `PROJECT-7` and the merge request in GitLab contains the improvement 3. 在合并請求描述中，我們使用問題關閉觸發器`Closes PROJECT-7` . 4. 合并請求合并后，Jira 問題將自動關閉，并帶有注釋和指向解決該問題的提交的關聯鏈接. 在以下屏幕截圖中，您可以看到指向 Jira 問題的鏈接的外觀. [![A Git commit that causes the Jira issue to be closed](https://img.kancloud.cn/a9/0e/a90ea66b3820e00c8453de029dd2a9da_959x537.png)](img/jira_merge_request_close.png) 合并此合并請求后，將通過指向解決該問題的提交的鏈接自動關閉 Jira 問題. [![The GitLab integration closes Jira issue](https://img.kancloud.cn/62/7b/627b053ce409ac92192a4d5c6a4b715d_761x831.png)](img/jira_service_close_issue.png) ## Troubleshooting[](#troubleshooting "Permalink") 如果這些功能不能按預期方式工作，則可能是由于集成設置的配置存在問題. ### GitLab is unable to comment on a Jira issue[](#gitlab-is-unable-to-comment-on-a-jira-issue "Permalink") 如果您希望 GitLab 也可以這樣做，請確保您為集成設置的 Jira 用戶具有正確的訪問權限，可以發表有關 Jira 問題的評論并轉換問題. 如果禁用了 GitLab 問題跟蹤器，則 Jira 問題參考和更新注釋將不起作用. ### GitLab is unable to close a Jira issue[](#gitlab-is-unable-to-close-a-jira-issue "Permalink") 確保在" Jira"設置中設置的" `Transition ID`與您的項目解決問題所需的`Transition ID`匹配. 確保尚未將 Jira 問題標記為已解決；也就是說，未設置" Jira 問題解決"字段. （不應在 Jira 列表中刪除它.） ### CAPTCHA[](#captcha "Permalink") 在連續幾次失敗的登錄嘗試后，可能會觸發 CAPTCHA，這可能會在測試 Jira 集成時導致`401 unauthorized`錯誤. 如果已觸發驗證碼，則您將無法使用 Jira 的 REST API 對 Jira 站點進行身份驗證. 您將需要登錄到您的 Jira 實例并完成 CAPTCHA.