GitHub連携

GitHub連携

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

開発者向けのプラットフォームであるGitHubを使用して、コードの変更を追跡し、改善や修正を行えます。Zoho SprintsのワークスペースをGitHubと連携すると、リポジトリを管理できます。
情報
アクセス権限：ワークスペースの所有者

GitHubアカウントの認証

  1. 右上の歯車アイコンをクリックします。設定画面が表示されます。
  2. ［マーケットプレイス］の［その他］を選択します。
  3. GitHubアプリの［設定］をクリックします。
  4. 規約に同意し、［認証］をクリックします。
自分のリポジトリ：GitHubアカウントで作成したすべてのリポジトリが一覧表示されます。

ワークスペースのリポジトリ：自分のリポジトリから関連付けたすべてのリポジトリが一覧表示されます。関連付けたリポジトリは、プロジェクトに関連付けることができます。プロジェクトに関連付けると、ワークスペースのメンバーは、クイックコマンドや作業項目の詳細ページから、コミットやプルリクエストを作業項目に追加または添付できます。

OAuthの要求と承認の手順

組織のメンバーまたは外部コラボレーターが、OAuthアプリによる組織のリソースへのアクセスを要求すると、その要求は組織の所有者に送信されます。組織の所有者は、要求を承認または拒否できます。組織の所有者は、このヘルプドキュメントの手順に従って要求を確認できます。

OAuthアプリに対する組織の承認の要求

  1. GitHubの任意のページの右上にあるプロフィール画像をクリックし、［設定］をクリックします。
  2. サイドバーの「連携」セクションで、［アプリケーション］をクリックします。
  3. ［認証済みOAuthアプリ］タブをクリックします。
  4. アプリケーションの一覧で、アクセスを要求するOAuthアプリの名前をクリックします。
  5. OAuthアプリからのアクセスを許可したい組織の横にある［アクセスを要求］をクリックします。
  6. OAuthアプリのアクセス要求に関する情報を確認し、［所有者に承認を要求］をクリックします。
詳細は、このGitHubのドキュメントもご参照ください。

組織のOAuthアプリの承認

組織のメンバーまたは外部コラボレーターが、OAuthアプリによる組織のリソースへのアクセスを要求すると、組織の所有者は要求を承認または拒否できます。

OAuthアプリのアクセス制限が有効な場合、組織のメンバーと外部コラボレーターは、組織のリソースにアクセスするOAuthアプリを認証する前に、組織の所有者に承認を要求する必要があります。

組織の所有者は、未承認のOAuthアプリやGitHub Appsに対するアクセス要求を外部コラボレーターに許可するかどうかを選択できます。
  1. GitHubの右上にあるプロフィール画像をクリックし、［組織］をクリックします。
  2. 対象の組織をクリックして選択します。
  3. 組織名の下にある［設定］をクリックします。
  4. ［設定］タブが表示されない場合は、ドロップダウンメニューを選択し、［設定］をクリックします。
  5. サイドバーの「サードパーティーのアクセス」セクションで、［OAuthアプリのポリシー］をクリックします。
  6. 承認するアプリケーションの横にある［確認］をクリックします。
  7. 要求されたアプリケーションの情報を確認し、［アクセスを許可］をクリックします。
詳細は、このGitHubのドキュメントもご参照ください。

自分のリポジトリとワークスペースのリポジトリの関連付け

  1. 右上の歯車アイコンをクリックします。
  2. ［マーケットプレイス］の［その他］を選択します。
  3. ［GitHub］を選択します。
  4. ［自分のリポジトリ］でリポジトリの一覧を確認します。
  5. リポジトリ名にカーソルを合わせます。
  6. リポジトリ名の横にある矢印アイコンをクリックし、リポジトリをワークスペースに関連付けます。
  7. ワークスペースのリポジトリにプロジェクトを関連付けます。
  8. ワークスペース内のプロジェクトを、関連付け済みのリポジトリに関連付けることができます。
  9. ［GitHub］に移動します。
  10. ［ワークスペースのリポジトリ］でリポジトリの一覧を確認します。
  11. ［プロジェクトの関連付け］ボタンをクリックします。
  12. プロジェクトを選択します。
  13. ［更新］をクリックします。
ワークスペースのリポジトリに関連付けられるプロジェクトは、最大50件です。

リポジトリの課題とプロジェクトの同期

プロジェクトをリポジトリに関連付ける際に、「課題プロジェクト」として指定できます。これにより、以降にリポジトリに追加されるすべての課題が自動的に同期されます。
  1. GitHubに移動します。
  2. ［プロジェクトの関連付け］ボタンをクリックします。
  3. プロジェクトを選択します。
  4. 切り替えスイッチをクリックして、［課題のみ同期］を有効にします。
  5. ［更新］をクリックします。
リポジトリには複数のプロジェクトを関連付けることができます。ただし、［課題のみ同期］を有効にできるプロジェクトは1件のみです。
作業項目の詳細ページから、GitHubへのリンクに直接アクセスできます。
GitHubアイコンをクリックすると課題の詳細が表示され、［GitHubで表示］をクリックするとGitHubに移動します。

GitHubから同期される項目

  1. タイトル
  2. 説明
  3. タグ
メモ
メモ：
  1. 指定したプロジェクトには課題のみが同期されるため、すべての作業項目は標準の作業項目の種類「課題」で作成されます。
  2. 作業項目のステータスは、Zoho Sprintsの未完了と完了のステータスに対応付けられます。
  3. SprintsからGitHubへの作業項目の同期
  4. Sprintsでは、GitHubのデータを簡単に管理できます。Sprintsで作業項目を作成する際に、GitHubにも同時にデータを作成できます。作業項目の作成フォームには、その作業項目をGitHubアカウントに追加する機能があります。これによりデータが同期され、Sprintsとの双方向のやり取りが容易になります。

Sprintsから同期される項目

  1. タイトル
  2. 説明
  3. タグ
メモ
メモ：
プルリクエストのコメントでは、作業項目のタグ付けのみがサポートされています。

Zoho Sprintsのクイックコマンド

リポジトリをワークスペースに関連付け、プロジェクトをリポジトリに関連付けると、コミットやプルリクエストを添付できるようになります。使用できるコマンドは次のとおりです。

形式
構文
用途
#workitem
#<Project Prefix>- <i/I><Item number>
例：#SP-i30
作業項目のIDを表します。
#comment
#workitemid #comment <message1> #comment <message2>
例：#SP-I15 #comment 本日中に最終ビルドを共有してください。 #comment 既存の課題を修正し、ローカルビルドを更新してください。
メモ：
1つの作業項目に複数のコメントを追加できます。
作業項目にコメントを追加します。
#status
#workitemid #status <status_name>
例1：#SP-i20 #status Done
例2：#SP-i20 #status To_be_Tested
メモ：
1. ステータス名が複数の単語で構成される場合は、単語間をアンダースコアで区切ってください。
2. ステータス名では大文字と小文字は区別されません。
作業項目のステータスを更新します。
#priority
#workitemid #priority <priority_name>
例1：#SP-i40 #priority Critical
例2：#SP-i42 #priority Should_be
メモ：
1. 優先度名が複数の単語で構成される場合は、単語間をアンダースコアで区切ってください。
2. 優先度名では大文字と小文字は区別されません。
作業項目の優先度を更新します。
#time
#workitemid #time <hours>h <minutes>m
例：#SP-I52 #time 5h 30m
作業項目に工数を追加します。
 

作業項目にコミットやプルリクエストを関連付けるには、そのプロジェクトが、チームにマッピング済みのリポジトリに関連付けられている必要があります。コミットを関連付ける作業項目は、そのプロジェクトに属している必要があります。

GitHubユーザーのメールアドレスがZoho Sprintsのチームに登録されている必要があります。登録されている場合にのみ、コミット内のコマンド（#comment、#time、#status、#priority）を処理できます。

高度なコマンド

複数の作業項目に対する単一のコマンド

構文
#workitemid,#workitemid,#workitemid #comment <message>
例
#SM-I25,#SM-I42,#SM-I98 #comment 課題を解決し、ローカルビルドに反映しました。
実行結果
3つの作業項目すべてにコメントが追加されます。

単一の作業項目に対する複数のコマンド

構文
#workitemid #comment <message> #priority <priority_name> #time < > h < > m #status <status_name>
例
#SM-I34 #comment 要件を一覧にしてください #priority High #time 5h 3m 20s #status In_progress
実行結果
作業項目にコメントと工数が追加されます。また、ステータスと優先度が更新されます。

複数の作業項目に対する複数のコマンド

構文
#workitemid,#workitemid,#workitemid #comment <message> #priority <priority_name> #time <>h <>m #status <status_name>
例
#SM-I34, #SM-I45, #SM-I54 #comment 要件を一覧にする #priority High #time 5h 3m #status In_progress
実行結果
3件すべての作業項目にコメントと工数が追加され、ステータスと優先度が更新されます。

作業項目の詳細セクションからのコミットの関連付け

  1. 作業項目の詳細ページに移動します。
  2. タブから［GitHub］を選択します。
  3. ［コミットを関連付ける］をクリックします。
  4. 必要な詳細情報を入力します。※すべての項目は入力必須です。
  5. ［関連付ける］をクリックします。

作業項目の詳細セクションからのプルリクエストの関連付け

  1. 作業項目の詳細ページに移動します。
  2. タブから［GitHub］を選択します。
  3. ［プルリクエストを関連付ける］をクリックします。
  4. 必要な詳細情報を入力します。※すべての項目は入力必須です。
  5. ［関連付ける］をクリックします。
GitHubまたは作業項目の詳細ページからのコミットの追加が実行条件となり、作業項目の担当者にフィードメッセージと通知が送信されます。

作業項目IDのコピー方法

プロジェクトの接頭語とIDを手動で指定するのは手間がかかります。作業項目の詳細ページから作業項目IDをコピーすれば、コミットメッセージやプルリクエストのコメントに貼り付けられます。

コミットとプルリクエストの削除

作業項目の詳細ページからコミットとプルリクエストを直接削除できます。関連付けられたコミットやプルリクエストにカーソルを合わせ、をクリックします。

コマンドの利用権限

コメントの追加

  1. コミットで作業項目にコメントを追加するには、プロジェクト内の有効なユーザーである必要があります。
  2. プロジェクトに所属していれば、誰でもバックログ内の作業項目にコメントを追加できます。
  3. 作業項目にコメントを追加するには、そのスプリントに参加し、作業項目が自分に割り当てられている必要があります。
  4. 未割り当ての作業項目にもコメントを追加できます。

工数の追加

  1. 作業項目に工数を追加するには、プロジェクト内の有効なユーザーである必要があります。
  2. 工数を記録できるのは、進行中のスプリント内の作業項目のみです。
  3. そのスプリントに参加している必要があります。
  4. 未割り当ての作業項目や、自分に割り当てられた作業項目にも工数を記録できます。

優先度の更新

  1. 作業項目の優先度を更新するには、プロジェクト内の有効なユーザーである必要があります。
  2. 指定する優先度名は、プロジェクトに登録されている必要があります。
  3. 優先度を更新できるのは、進行中のスプリント、今後のスプリント、バックログ内の作業項目のみです。
  4. 作業項目の優先度を更新するには、管理者、共同管理者、プロジェクトマネージャーのいずれかである必要があります。
  5. ステータスが完了の作業項目の優先度は更新できません。

ステータスの更新

  1. 作業項目のステータスを更新するには、プロジェクト内の有効なユーザーである必要があります。
  2. 指定するステータス名は、プロジェクトに登録されている必要があります。
  3. ステータスを更新できるのは、進行中のスプリント内の作業項目のみです。
  4. 作業項目のステータスを更新するには、スプリントの所有者、担当者、管理者、マネージャー、スプリントの作成者のいずれかである必要があります。
GitHubまたは作業項目の詳細ページからのコミットの追加が実行条件となり、作業項目に割り当てられたユーザーにフィードメッセージと通知が送信されます。

リポジトリとプロジェクトの関連付けの解除

リポジトリとプロジェクトの関連付けは、次の2つの方法で解除できます。

関連付けられたプロジェクトのセクションからの解除

  1. ［GitHub］に移動し、［ワークスペースのリポジトリ］セクションを開きます。
  2. ［プロジェクトを関連付ける］ボタンをクリックします。プロジェクトの一覧が表示されます。
  3. ［プロジェクトの関連付け］フォームで、プロジェクトの選択を解除します。
  4. ［更新］をクリックします。
  5. ワークスペースのリポジトリから直接解除
  6. ［GitHub］に移動し、［ワークスペースのリポジトリ］を開きます。
  7. リポジトリの横にある件数をクリックします。
  8. 関連付けを解除するプロジェクトにカーソルを合わせます。
  9. ［プロジェクトを削除］をクリックします。
情報

リポジトリとプロジェクトの関連付けを解除した場合の動作

GitHub経由、またはZoho Sprintsの作業項目の詳細セクションから直接、プロジェクト内の作業項目にコミットやプルリクエストをすばやく関連付けることができます。

ワークスペースからのリポジトリの削除

  1. ［GitHub］に移動します。
  2. ［ワークスペースのリポジトリ］でリポジトリの一覧を表示します。
  3. リポジトリ名にカーソルを合わせます。
  4. リポジトリ名の左端にある矢印アイコンをクリックし、チームとリポジトリの関連付けを解除します。


情報

チームからリポジトリを削除した場合の動作

GitHub経由でも作業項目の詳細ページから直接でも、作業項目にコミットやプルリクエストを関連付けることができなくなります。

GitHubの認可の解除

  1. Zoho SprintsからGitHubアカウントをいつでも削除できます。手順は次のとおりです：
  2. ［GitHub］に移動します。
  3. ［自分のリポジトリ］の下部にあるをクリックします。確認のポップアップが表示されます。
  4. ［削除］をクリックします。
情報

認可を解除した場合の動作

リポジトリを［ワークスペースのリポジトリ］に関連付けると、両方のアプリケーション間にWebhookまたはサブスクリプションが作成されます。認可を解除すると、両方のアプリケーション間の連携が停止し、関連付けられているすべてのリポジトリと、それらに関連付けられたプロジェクトが削除されます。

ただし、Webhookやサブスクリプションは削除されません。認可時に作成されたWebhookやサブスクリプションを削除するには、GitHubの設定に移動し、該当のワークスペース用に作成されたWebhookを無効にします。