GitLabの課題管理システムとしてBacklogと連携する方法

目的

GitLab のExternal issue trackersという機能を用いて、 Backlog で管理されている課題を GitLab と紐づけます。

これにより GitLab 上で特定の文字列を用いると、 Backlog の課題へのリンクに変換してくれるようになります。

GitLab の External issue trackers について

GitLab にはそもそもissuesという課題管理のための機能が備わっています。しかし、プロジェクトのさまざまな理由から GitLab 外で課題管理をしている場合に、その課題管理システムと GitLab を連携させることができます。

一部の外部課題管理システムは連携のための手順が載っていますが、 Backlog のように手順が示されていない場合はCustom issue trackerの手順に沿って連携させることができます。

GitLab と Backlog を連携する

外部の課題管理システムを使う場合、 GitLab のissuesと併用するパターンと外部の課題管理システムのみを使うパターンが選択できます。今回は前者のパターンの手順を示します。

1. GitLabの対象プロジェクトに移動
2. サイドバーからSettings > Integrationsを選択
3. Custom issue trackerを選択
4. Enable integrationのチェックボックスを有効にする
5. Backlogの各種URLを入力する
   1. Project URL: https://${スペースID}.backlog.com/projects/${プロジェクト名}
      • プロジェクトホームのURLです
   2. Issue URL: https://${スペースID}.backlog.com/view/${プロジェクト名}-:id
      • 各課題のURLです。:idの部分は動的パラメータです
   3. New issue URL: https://example.com/
      • 最新のバージョンでは不要になったフィールドのため任意のURLを指定します。(issue)
6. Save changesを選択

以上で GitLab と Backlog が連携できました。

プロジェクトのサイドメニューにCustom issue trackerというBacklogへのリンクが追加されます。

また、 マージリクエストやコミットなどで${プロジェクト名}-:idという文字列を用いると課題へのリンクへ変換してくれるようになりました。

href="https://${スペースID}.backlog.com/view/MYPROJECT-1"