メインコンテンツにスキップ

Githubインテグレーションガイド

CoadmapでGithub連携する為の手順説明になります。

対応者:Kazuya Shiraishi

1. インテグレーション設定からGithubを選択する

サイドバー上部の歯車アイコンをクリックし、組織の設定ページへ遷移します。

インテグレーションを選択しインテグレーション可能なサービスよりGitHubを選択してください。

2. 連携したいGitHubのワークスペースを選択する

「有効にする」ボタンを押しますと新規ウィンドウでGitHubのページが開きますので連携したいワークスペースを選択し操作を進めます。

3. 用途に応じてリポジトリのアクセス設定を選択します

特定のリポジトリのみを選択したい場合はOnly select repositoriesを選択しSelect repositoriesから任意のリポジトリを選択します。

リポジトリアクセスを選択後「Install」ボタンを押します。

接続が完了するとCoadmapにリダイレクトされ接続されたGitHubの組織に接続中と表示されます。

4. プロジェクトに連携する

プロジェクトにGitHubのリポジトリを連携するには、プロジェクトの「設定」→「外部リポジトリ連携」を開きます。

「リポジトリ追加」ボタンをクリックします。

追加したいリポジトリを選択し「追加」ボタンをクリックします。

追加が完了すると同期しているリポジトリ一覧に表示されます。

リポジトリ連携完了後、Issueが同期されタスクとして作成されます。

Issueから同期して作成されたタスクは本文やコメントも同期されます。

また、Issueとタスクが紐づいている場合、CoadmapでタスクをクローズするとIssueもクローズされます。

5. タスクとGitHubのプルリクエストを同期させる

GitHub上でプルリクエストを作成時にCoadmapのタスクリンクを貼り付ける事でタスクとプルリクエストを同期することが可能になります。

タスクとプルリクエストが同期されるとプルリクエストのリンクやマージリクエストの欄が追加されます。

この状態でGitHubのプルリクエストにレビュワーを設定するとCoadmapのタスクは自動でレビュー中のタスクに移動します。

※ プルリクがマージされてもタスクは自動で終了したタスクには移動しません。

6. GitHubの同期が止まったとき(連携が切れた場合)

GitHub側の操作によってCoadmapとの連携が切れると、Issueの同期、プルリクエストの同期、CoadmapでタスクをクローズしたときのIssueクローズなど、GitHub連携の機能がすべて停止します。

連携が切れると、そのリポジトリを連携しているプロジェクトの画面上部に 「〇〇 の GitHub 連携が切れました」 という警告バナーが表示されます。

連携が切れる原因は2つあり、原因によって対処が異なります

原因

対処

Coadmap GitHub Appの Only select repositories の対象からリポジトリが外された

GitHub側で対象リポジトリに戻すと、自動的に再接続され警告も消えます

リポジトリを 別の組織に移転 した

移転先の組織でGitHub Appを設定し、手動で接続し直す必要があります

Case 1. GitHub Appの対象リポジトリから外れた場合

GitHubのCoadmap GitHub Appの設定を開き、Only select repositories の対象に該当リポジトリを再度追加してください(設定手順は「3. 用途に応じてリポジトリのアクセス設定を選択します」と同じです)。追加が完了すると、Coadmap側の連携は自動的に復旧し、警告バナーも自動で消えます。

※ この場合、Coadmap側での操作は必要ありません。

Case 2. リポジトリを別の組織に移転した場合

リポジトリの移転による連携切れは自動では復旧しません。以下の手順で接続し直してください。

  1. 移転先の組織でCoadmap GitHub Appを有効にします(手順は「2. 連携したいGitHubのワークスペースを選択する」と同じです)

  2. 警告バナーの「再接続する」をクリックし、プロジェクト設定の「外部リポジトリ連携」を開きます

  3. 移転後のリポジトリを選択して接続します(手順は「4. プロジェクトに連携する」と同じです)

警告バナーを非表示にする

警告バナーは右側の「×」から非表示にできます。クリックすると 「この警告を非表示にしますか?」 という確認モーダルが表示されるので、「非表示にする」をクリックします。

  • 一度非表示にした警告は 二度と表示されません。非表示の操作は自分だけでなく、そのプロジェクトを閲覧するメンバー全員に反映されます

  • 非表示にしても連携は復旧しません。同期を再開するには、Case 1・Case 2の手順で再接続してください

Tips

リポジトリの移転による警告(Case 2)は、GitHub側で元の組織に戻しても自動では解消されません。再接続が完了したら、警告バナーは手動で非表示にしてください。

こちらの回答で解決しましたか?