Backlogに課題が追加されたらGithubにも登録する方法

[Yoomとは]

Yoomを利用してBacklogとGitHubの連携を試してみる

事前に準備するもの

・Backlogのアカウント、プロジェクト、テスト用課題（ドメインとプロジェクトID）
・GitHubのアカウント、プロジェクト（アカウント、オーナー、リポジトリ名）

テストプロジェクトをたてました。

まず、以下のテンプレートをマイプロジェクトにコピーします。テンプレ名の先頭に【コピー】と表示されますが、任意で変更できますので、一旦そのままで進めます。
コピーされたてのフローボットはトリガースイッチが【OFF】になっています。
アプリ連携の設定が進むと【ON】に切り替えできるので、最初は【OFF】のまま進めましょう。

‍

まずはYoomとBacklogの連携。事前に準備しておいたアカウントを設定します。

次にプロジェクトの連携に進みます。
連携アカウントとアクションを設定。アクションはテンプレのデフォルトで設定されています。

トリガーの起動間隔は5分、10分、15分、30分、60分のいずれかで設定できます。
※ご利用プランによって、設定できるトリガーの最短間隔が違うので、その点は要チェックです。なお、基本的にはそのプランの最短の起動間隔にしてお使いいただくことをおすすめします。

ドメイン、プロジェクトIDを設定します。
ドメイン→Backlog URL内「https://（ここ）/　」の文字列を入力
プロジェクト→課題一覧ページのURL内「projectId=（ここ）」の文字列を入力

すぐ下のテストボタンを押下します。
テスト→成功

次にGitHub連携の設定に進みます。GitHubも同じように連携アカウントを設定し、API接続設定へ進みます。

アクションを設定。テンプレートはデフォルトで「Issueの作成」になっていますので、このまま進めてOKです。
連携するアカウントを選択します。
登録しているメールアドレスとパスワードでログインするんですが、2段階認証になっているのでメールを閲覧できる環境で進めてくださいね。

API設定に進みます。ここではオーナー名とリポジトリ名を設定します。
テストに進む→成功
失敗した場合はエラー項目が表示されます。エラーメッセージは英語ですが、翻訳を使って原因を特定してください。

連携に成功したら、フローボットを起動してみましょう！トリガーを【ON】にし、Backlogの課題を追加します。
すると、GitHubのIsuueに課題の内容が反映されます。

私が成功するまで何回か試していたのですが、課題を設定するときに担当者の名前を入れるとエラーになってしまいました。これはBacklogとGitHubの両方でアカウント名の紐付けができていないため発生したエラーでした。

データマッピングを行えば解決できますが、これはまた別の機会に。

GithubでIssueが作成されたらBacklogにタスクを追加する

今度は逆にGithubのデータをBacklogに同期してみます。事前に準備するものは先ほどと同じです。
基本は先ほどの連携と順番が逆になっただけなので、サクサクできました。

まずトリガーの設定をします。今回もデフォルトの設定のまま進めますね。
トリガーアクションはデフォルトで「Issueが新しく作成されたら」になっていますので、そのまま「次へ」に進んでください。

アプリトリガーのAPI設定に進みます。先ほどと同じくオーナー名、リポジトリ名を取得し入力します。

リポジトリまで入力できたらテストします。

次にBacklogの設定に進みます。課題を作成するアウトプットの内容はこちらで設定します。
まず、連携するアカウントを設定します。今回は先ほどの連携と同じプロジェクトでテストしました。

次にアウトプットの内容を設定します。
選べるオペレーションがたくさんありますが、デフォルトの「課題の追加」で進めてみます。

課題に吐き出す内容の詳細を決めていきます。

課題の開始日など一定のルールがあればいいんですが、課題ごとに始めるタイミングが違う場合は直接Backlogを操作することもありそうです。
テストしてみて成功になったら起動させてみましょう。

フローボットのトリガーを【ON】にして起動！GitHubのIssueにコメントを登録します。
今回は先ほどと同じプロジェクトでテストしたため、Backlogに追加した課題とIIssueのコメントが無限ループ状態になりました。永遠に課題が増えていってる！！

ちょっとびっくりしましたが、この辺の設定は間にデータマッピングを設定することで解決できまそうです。
BacklogにIssueからのコメントで課題がたっていたことが確認できましたので連携大成功です！

このフローは以下の2つのうち上のテンプレートです。下のテンプレートもよかったらぜひ試してみてください！

Backlogを活用した自動化例

1.このフローでは、Backlogに課題が追加されたらBoxに自動でフォルダを作成します。課題解決のための情報格納場所を自動で作成し、定型業務を省くことができます。

2.Backlogに課題が追加されたら、Mazricaに案件情報を登録するフローです。自動で情報の登録を行うことで情報共有のスピードを早め、迅速な対応や意思決定につなげることができます。

3.Backlogで課題が登録されたらDiscordに通知する作業も自動化できます。通知を自動化することで課題が追加されたことをいち早く知ることができ、課題解決へ迅速な対応を行えますね。

Githubを活用した自動化例

1.GitHubにIssueが作成されたらSlackに通知するフローです。いちいちGithubを開かなくてもSlackで知らせてくれるので助かりますね。

2.GitHubでIssueが新しく作成または更新されたらGoogleスプレッドシートに追加することもできます。普段お使いのツールでにカスタマイズして便利に活用してみてください！

3.GitHubでプルリクエストが作成されたら、Notionにも追加するという使い方もできます。Notionをデータベースのように使いたい方におすすめです。

BacklogとGitHubを連携することでどのようなメリットがあるか

(1)GitHubからBacklogへ連絡事項・指示内容の通達が自動化できると、状況把握時間の短縮につながります。また、転記ミスがなくなるため確認事項のやりとりも少なくなるでしょう。

(2)共同作業者がどちらかにしか閲覧権限がない場合があります。GitHubは開発者・進行管理担当者以外は権限が限定されていることがあります。そのため、内容の転記までタイムラグが発生しがちです。通達事項の行き来を自動化を行うことで、GitHubの閲覧権限がないメンバーも、プロジェクト全体の状況を把握しやすくなります。

Backlogでは、プロジェクトごとにGitとの連携が可能です。
作業後にプッシュを行うと、課題にコメントで変更点のログを自動で残してくれます。これにより、共同作業する人は更新されたことにいち早く気づくことができるでしょう。
デフォルトではこういった機能が充実していますが、さらに連携を充実させることで課題進行の手間が省けます。

まとめ

今回テンプレートを使って、デフォルトの設定通りにアプリ連携を実現できました。
この自動化により、BacklogとGitHubの情報統一化や情報共有スピードが上がり、業務効率の向上が期待できそうですね。
YoomではBacklog×GitHubだけでなく、その他多数のフローボットテンプレートもあるので、気になったテンプレートがあればぜひ使ってみてください！
では、また〜！