Contents
BacklogとGitの連携手順:プロジェクト管理とバージョン管理の統合を実現する
BacklogとGitを連携させることで、課題管理とコードのバージョン管理を一括して行えるようになります。この記事では、管理者権限を持つアカウントでBacklogにログインし、プロジェクト設定からGitリポジトリを追加する具体的な手順をステップバイステップで解説します。開発チームの運用効率向上を目指すDevOpsエンジニアやチームリーダーにとって、必須となる知識を網羅しています。
導入:BacklogとGitの連携目的と準備
BacklogとGitを連携する意義は、「コードの変更履歴と課題管理(タスク)の直接的な関連付け」にあります。これにより、コミットメッセージでタスクIDを参照することで、自動的にBacklog内でのタスク進捗が可視化され、工程管理の精度が向上します。
事前に準備するべき環境には、以下の3つがあります。
- 管理者権限を持つBacklogアカウント:リポジトリの登録や設定変更が必要です。
- SSHキーペア生成ツール(例:
ssh-keygen):Gitとの接続に使用します。 - Gitリポジトリが存在していること:既存のリポジトリを連携するか、新たに作成してください。
プロジェクト設定画面へのアクセス方法
Backlogでプロジェクト設定に移動するには、以下のステップが必要です。管理者アカウントでログインした上で操作を行ってください。
管理者権限の確認
- Backlogトップページ右上のユーザー名から「プロフィール設定」を開きます。
- 「役割・権限」タブをクリックし、プロジェクト管理者以上の権限があることを確認します。
プロジェクト選択手順
- ダッシュボード画面で対象となるプロジェクトを選択します。
- 左メニューから「プロジェクト設定」を開き、「Gitリポジトリ」セクションをクリックしてください。
注意: 管理者権限がない場合、プロジェクト設定へのアクセスはできないため、事前に権限を確認しておきましょう。
SSH公開鍵の生成とBacklogへの登録
SSH公開鍵を生成し、Backlogに登録することでGitリポジトリとの安全な接続が可能になります。
SSHキーペア作成手順
- ローカル環境(PCやサーバー)でターミナルを開きます。
-
以下のコマンドを実行し、SSHキーペアを作成します:
bash
ssh-keygen -t ed25519 -C "[メールアドレス削除]" -
ファイル名の入力プロンプトで、任意のパス(例:
~/.ssh/id_ed25519)を指定します。 - パスフレーズを設定するか、空欄にしてください。
公開鍵のBacklog登録方法
- 生成された公開鍵ファイル(例:
id_ed25519.pub)を開き、内容をコピーします。 - Backlogの「ユーザー設定 > SSHキー管理」画面にアクセスし、「SSHキーペアの追加」ボタンをクリックします。
- コピーした公開鍵を貼り付け、説明文(例:
Git用SSH鍵)を入力して保存してください。
Gitリポジトリの追加・編集・削除操作
Backlog内からGitリポジトリを管理する際には、「Gitリポジトリ」セクションでCRUD操作が可能です。
新規リポジトリの登録
- 「Gitリポジトリ」画面右上の「リポジトリの追加」ボタンをクリックします。
- リポジトリURL(例:
[メールアドレス削除]/yourname/project.git)と、Backlog内で使用する名前を入力します。 - 「登録」ボタンを押下し、リポジトリの情報を保存してください。
既存リポジトリ情報の更新
- リストから編集したいリポジトリを選択し、「編集」ボタンをクリックします。
- URLや表示名などの変更後、「保存」ボタンで反映させます。
不要なリポジトリの削除
- 削除対象のリポジトリを選択し、「削除」ボタンをクリックします。
- 確認画面で「削除する」を選択してください。
注意: リポジトリを削除すると、Backlog内でそのリポジトリに関連付けられたコミット情報も完全に削除され、復元不可能です。操作前に必ずバックアップや確認が必要です。
コミットメッセージと課題(タスク)の連携方法
GitでのコミットメッセージにタスクIDを含めることで、Backlog内での進捗管理を自動化できます。
参照形式の標準化
- 例:
git commit -m "バグ修正 #TASK-123" - #TASK-123は、Backlog内のタスクIDです。
- ID形式はプロジェクトごとに異なりますが、必ず「#」で始めてください。
| プロジェクト | タスクIDの形式 | 補足 |
|---|---|---|
| プロジェクトA | #BUG-XXX | XXXは数字3桁 |
| プロジェクトB | #FEATURE-YYY | YYYはアルファベット+数字の組み合わせ |
| プロジェクトC | #TASK-ZZZ | 基本的に「#TASK-」で固定 |
自動リンク設定の有効化
- Backlogの「プロジェクト設定 > Gitリポジトリ」画面にアクセスします。
- 「自動リンク設定」チェックボックスをONにして保存します。
- これにより、Gitのコミットメッセージに含まれたタスクIDがBacklog内で自動的にハイパーリンクされます。
Visual Studio Codeとの連携設定例
VS CodeでBacklogとGitを統合して使うことで、コード編集時にも課題管理情報を一括表示できます。
拡張機能のインストール
- VS Codeの拡張機能マーケットプレイスから、「GitLens」や「Backlog for Visual Studio Code」を検索します。
- 「Install」ボタンで拡張機能を導入してください。
注意: 「Backlog for Visual Studio Code」といった拡張は、第三者製品であり、Backlog公式ではサポートされていません。使用時は事前に動作環境の確認をお願いします。
Backlogとの同期設定
- 拡張機能の設定画面から、Backlog APIトークンとプロジェクトIDを登録します。
- Gitリポジトリを開くと、コミットメッセージに含まれたタスクIDが自動的にBacklog内と同期されます。
- タスク進捗状況は、VS Codeのサイドバーで一覧表示可能です。
まとめ
- プロジェクト管理とバージョン管理の連携:BacklogとGitを統合することで、工程管理の精度が向上します。
- SSH公開鍵の生成・登録:リポジトリへの安全な接続が必要です。
- コミットメッセージのタスクID参照:自動リンク設定で進捗状況を可視化できます。
- Visual Studio Codeとの連携:開発環境内での課題管理情報を即座に確認可能です。
以下が本記事の要点です:
- 管理者権限を持つアカウントでBacklogにログインする
- SSH公開鍵を生成し、Backlogに登録する
- Gitリポジトリを追加・編集・削除する
- コミットメッセージでタスクIDを参照する
- VS CodeでBacklogとの同期設定を行う