GitHub連携

GitHub連携

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

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

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アプリへのアクセスを要求できるようにするかどうかを選択できます。
  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. ［タグ］
Notes
メモ。
  1. マークされたプロジェクトにはバグのみが同期されるため、すべての作業項目は初期設定の作業項目種別「BUG」で作成されます。
  2. 作業項目のステータスは、Zoho Sprintsの未完了ステータスと完了ステータスに関連付けられます。
  3. SprintsからGitHubへの作業項目の同期
  4. Sprintsでは、GitHub内のデータ管理が簡単になります。Sprintsで作業項目を作成しながら、同時にGitHubにもデータを作成できます。項目作成フォームには、その作業項目をGitHubアカウントに追加する機能が含まれています。これによりデータが同期され、Sprintsとの間での連携がスムーズになります。

Sprintsから同期される項目

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

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つの作業項目すべてにコメントが追加されます。

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

構文
#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. ［プロジェクトを削除］をクリックします。
Info

プロジェクトとリポジトリーの関連付けを解除するとどうなりますか？

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

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

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


Info

リポジトリーがチームから削除されるとどうなりますか？

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

GitHub認証の削除

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

認証を削除するとどうなりますか？

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

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