Backlogの課題にGitHubのプッシュとプルリクを連携して便利にGit利用

はじめまして、中井です。
「作業が効率化できてちょっと楽しくなる何か」を探して日々奮闘しています。
よろしくお願いします。

みなさんは、ドキュメントやソースコードの管理にGitはお使いですか?
Gitはバージョン管理システムの1つでBacklogにもGit機能があります。

BacklogのGitは課題との連携が容易で、コミットコメントやレビュー依頼としても利用できるプルリクエスト通知が課題のコメントとして追加されます。
課題に関連した(紐付けた)修正がまとめて確認できるので、私も非常に助かっています。

【BacklogのGitでプッシュした時にコメントが追加されたときの画像です】

ただ、Backlog以外のGitを使っている場合は、この恩恵は受けられません。

弊社でも一部のプロジェクトはBacklogではなくGitHubでドキュメントやソースコードの管理をしています。
BacklogとGitHubを使っていると課題管理はBcklogで行っているのに
課題に関係するドキュメントやソースコードの変更はGitHubで確認しなければなりません。

サービスを2つ見ていくのは手間ですが、会社やプロジェクトの事情でBacklogにまとめることができないこともあります。

そこで、今回は「GitHubのプッシュとプルリクエストでBacklogの課題にコメント追加する」をやってみました!
この記事は、以下のような方にお勧めです。

  • Backlogを使っているけれどGitがまだBacklogに移行できていない
  • プロジェクトの方針でBacklog以外のGitを使っている

まずは、GitHubにWebhookを設定してAWSのへプッシュとプルリクエストの情報を送信できるようにします。
次に、AWSのLambda関数を使いGitHubから来た情報をBacklogのAPIを使って課題にコメント追加できるようにしました。

Backlogの機能と同じようにGitHubのコメントに課題のキーを入れておくとその課題にコメントが追加されます。

【コメントに課題キーを入れておくとその課題にコメント追加されます】
【変更の詳細はGitHubの画面で確認できます】

コメントにあるURLを表示するとGitHubの画面に移動できます。

URLを表示することで、変更の詳細な内容をBacklogの課題にURLで紐づけておくことができます。

    

BacklogのGitと同様に複数の課題が関連する場合は、その課題にもコメントが追加されます。
これで、ほかの課題でもドキュメントやソースコードの変更を管理できます。

【この画像の例では親課題にもコメントを追加しています】

プルリクエストは、課題へのコメント追加と合わせてレビューアーに設定された人に通知がつくようにしました。
これで、GitHubにレビュー依頼(プルリクエスト)が来るとレビューアーがBacklog上で依頼に気が付くことができます。

【確認するとチェックマークがつくので確認したが他の人にもわかります】

   


URLも表示するので他のチャットツールやBacklogのコメントでレビュー依頼をする手間が省けます。

  

    

今回は、シンプルにプッシュとプルリクエストで課題にコメント追加するようにしましたが、
GitHubのコメントにタグを設定して課題を操作できるようにしたり、
レビューコメントがついたらBacklogでレビューを依頼した人に通知をつけたりと
プロジェクトや会社のニーズに合わせた機能を追加すると便利ですね。

Backlogと他のサービスを使っていて両方管理するのは手間!という場合でもサービスを連携させればより効率的に管理を行うことができます。
この仕組みに興味を持たれた方は、是非問い合わせフォームからお問い合わせください。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です