GitHub連携

GitHub連携

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

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

GitHubアカウントの認証 

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

Workspace Repository：Workspace Repositoryには、個人のリポジトリーからワークスペースにマッピングしたすべてのリポジトリーが一覧表示されます。マッピング後、これらのリポジトリーをプロジェクトに関連付けできます。関連付け後は、クイックコマンドまたは作業項目の詳細ページから、コミットやプルリクエストを作業項目に追加または添付できます。
Notes
組織メンバーまたは外部コラボレーターが、組織のリソースにアクセスするためにOAuthアプリのアクセス権を要求すると、その要求は組織担当者に送信されます。組織担当者は要求を承認または拒否できます。組織担当者は、このヘルプドキュメントの手順に従って要求を確認できます。

GitHubマーケットプレイスからZoho Sprintsアプリを直接連携することもできます。

My RepositoryのリポジトリーのWorkspace Repositoryへのマッピング

  1. 右上の歯車アイコンをクリックします。
  2. ［マーケットプレイス］の［その他］を選択します。
  3. ［GitHub］を選択します。
  4. MyRepositoryにリポジトリーの一覧が表示されます。
  5. リポジトリー名にマウスオーバーします。
  6. リポジトリー名の横にある矢印アイコンをクリックして、リポジトリーをワークスペースにマッピングします。
ワークスペースリポジトリーへのプロジェクトの関連付け 
ワークスペースのプロジェクトを、マッピング済みのリポジトリーに関連付けできます。
  1. ［GitHub］に移動します。
  2. Workspace Repositoryにリポジトリーの一覧が表示されます。
  3. ［プロジェクトを関連付け］ボタンをクリックします。
  4. プロジェクトを選択します。
  5. ［更新］をクリックします。
ワークスペースリポジトリーに関連付けできるプロジェクトは50件までです。

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

GitHubから同期される項目
件名、説明、タグ
 
メモ：
  1. マークしたプロジェクトには課題のみを同期するため、作業項目はすべて、既定の作業項目の種類である［BUG］として作成されます。
  1. 作業項目のステータスは、Zoho Sprintsの［開く］および［完了済み］ステータスにマッピングされます。

SprintsからGitHubへの作業項目の同期

Sprintsでは、GitHub内のデータ管理が簡単になります。Sprintsで作業項目を作成しながら、GitHubにデータを作成できます。作業項目の作成フォームには、その作業項目をGitHubアカウントに追加する機能が含まれています。データは同期され、GitHubとSprints間の連携がスムーズになります。

Sprintsから同期される項目
件名、説明、タグ
メモ：

Zoho Sprintsのクイックコマンド

リポジトリーのマッピングと、リポジトリーへのプロジェクトの関連付けが完了したら、コミットやプルリクエストの添付を開始できます。以下はサポートされているコマンドです。
プルリクエストのコメントでは、作業項目のタグ付けのみがサポートされています。

形式
構文
目的
#workitem
#<プロジェクト接頭語>- <i/I><アイテム番号>
例: #SP-i30
作業項目IDを表します。
#コメント
#workitemid #コメント <message1> #コメント <message2>
例: #SP-I15 #コメント EODまでに最終ビルドを共有してください。#コメント 既存の問題を修正し、ローカルビルドを更新してください。
メモ
1つの作業項目に複数のコメントを追加できます。
作業項目にコメントを追加します。
#ステータス
#workitemid #ステータス <status_name>
例1: #SP-i20 #ステータス 完了
例2: #SP-i20 #ステータス To_be_Tested
メモ
1. ステータス名が複数の単語で構成される場合は、アンダースコアで区切ってください。
2. ステータスは大文字小文字を区別しません。
作業項目のステータスを更新します。
#優先度
#workitemid #優先度 <priority_name>
例1: #SP-i40 #優先度 Critical
例2: #SP-i42 #優先度 Should_be
メモ
1. 優先度名が複数の単語で構成される場合は、アンダースコアで区切ってください。
2. 優先度は大文字小文字を区別しません。
作業項目の優先度を更新します。
#時間
#workitemid #時間 <時間>h <分>m
例: #SP-I52 #時間 5h 30m
作業項目に作業時間ログを追加します。
 
  • コミットとプルリクエストを項目に添付できるのは、プロジェクトがチームにマッピングしたリポジトリーに関連付けられている場合のみです。また、コミットを添付する作業項目は、関連付け済みプロジェクトに含まれている必要があります。
  • GitHubユーザーのメールアドレスがZoho Sprintsチームに登録されている必要があります。登録されている場合にのみ、#コメント、#時間、#ステータス、#優先度のコミットを処理できます。

詳細コマンド

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

構文
#workitemid,#workitemid,#workitemid #コメント <メッセージ>
例
#SM-I25,#SM-I42,#SM-I98 #コメント 課題は解決済みで、ローカルで作成して更新しました。
動作
3件の作業項目すべてにコメントが追加されます。

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

構文
#workitemid #コメント <メッセージ> #優先度 <priority_name> #時間 < > h < > m #ステータス <status_name>
例
#SM-I34 #コメント 要件をリスト出力 #優先度 高い #時間 5h 3m 20s #ステータス In_progress
動作
作業項目にコメントと作業時間が追加されます。また、ステータスと優先度も更新されます。

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

構文
#workitemid,#workitemid,#workitemid #コメント <メッセージ> #優先度 <priority_name> #時間 <>h <>m #ステータス <status_name>
例
#SM-I34, #SM-I45, #SM-I54 #コメント 要件をリスト出力 #優先度 高い #時間 5h 3m #ステータス In_progress
動作
3件の作業項目すべてにコメントと作業時間が追加され、ステータスと優先度が更新されます。

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

  1. 作業項目の詳細ページに移動します。
  2. Github タブを選択します。
  3. コミットを添付をクリックします。
  4. 必須の詳細を入力します。 * すべての項目は必須です。
  5. 添付するをクリックします。

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

  1. 作業項目の詳細ページに移動します。
  2. Github タブを選択します。
  3. プルリクエストを添付をクリックします。
  4. 必須の詳細を入力します。 * すべての項目は必須です。
  5. 添付するをクリックします。

GitHub経由、または作業項目の詳細ページからコミットを追加すると、フィードメッセージと通知がトリガーされ、作業項目の担当者に送信されます。

作業項目IDをコピーする方法

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

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

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

コマンドのアクセス権

コメントの追加

  • コミットで作業項目にコメントをタグ付けするには、プロジェクトの有効なユーザーである必要があります。
  • プロジェクトに所属していれば、誰でもバックログの作業項目にコメントを追加できます。
  • コメントを追加するには、スプリントのメンバーであり、かつ作業項目の担当者である必要があります。
  • 担当者未設定の作業項目にもコメントを追加できます。

作業時間の記録

  • 作業項目に作業時間を追加するには、プロジェクトの有効なユーザーである必要があります。
  • 作業項目の作業時間を記録できるのは、有効なスプリント内のみです。
  • スプリントのメンバーである必要があります。
  • 担当者未設定の作業項目や、自分が担当者の作業項目にも作業時間を記録できます。

優先度の更新

  • 作業項目の優先度を更新するには、プロジェクトの有効ユーザーである必要があります。
  • 指定する優先度名は、プロジェクトに既に存在する優先度である必要があります。
  • 作業項目の優先度を更新できるのは、有効および今後のスプリントと、バックログ内の作業項目のみです。
  • 作業項目の優先度を更新するには、管理者、共同管理者、またはプロジェクトマネージャーである必要があります。
  • 作業項目が［完了］ステータスの場合、優先度は更新できません。

ステータスの更新

  • 作業項目のステータスを更新するには、プロジェクトの有効ユーザーである必要があります。
  • 指定するステータス名は、プロジェクトに既に存在するステータスである必要があります。
  • 作業項目のステータスを更新できるのは、有効なスプリント内のみです。
  • 作業項目のステータスを更新するには、スプリント担当者、担当者、管理者、マネージャー、またはスプリント作成者である必要があります。
GitHub経由でコミットを追加するか、作業項目の詳細ページから追加すると、作業項目の担当ユーザーにフィードメッセージと通知が送信されます。

リポジトリーからのプロジェクトの関連付け解除

リポジトリーからプロジェクトの関連付けを解除する方法は2通りあります。

［関連付け済みプロジェクト］セクションから
  1. ［GitHub］に移動し、Workspaceの［Repository］セクションを開きます。
  2. ［プロジェクトを関連付ける］ボタンをクリックします。プロジェクトが一覧表示されます。
  3. ［プロジェクトを関連付ける］フォームで、対象プロジェクトの選択を解除します。
  4. ［更新］をクリックします。
Workspace Repositoryから直接
  1. ［GitHub］に移動し、Workspace Repositoryを開きます。
  2. リポジトリーの横にある件数をクリックします。
  3. 関連付けを解除したいプロジェクトにマウスオーバーします。
  4. ［プロジェクトを削除］をクリックします。
リポジトリーからプロジェクトの関連付けを解除するとどうなりますか？
 
GitHub経由、またはZoho Sprintsの作業項目詳細セクションから直接、プロジェクト内の作業項目にクイックコミットとプルリクエストを添付できます。

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

  1. ［GitHub］に移動します。
  2. Workspace Repositoryでリポジトリーの一覧を表示します。
  3. リポジトリー名にマウスオーバーします。
  4. チームからリポジトリーのマッピングを解除するには、リポジトリー名の左端にある矢印アイコンをクリックします。
チームからリポジトリーを削除するとどうなりますか？
 
GitHub経由、または作業項目の詳細ページから直接、作業項目にコミットとプルリクエストを添付できなくなります。

GitHub認可の削除

Zoho SprintsからGitHubアカウントの連携はいつでも削除できます。手順は次のとおりです。
  1. ［GitHub］に移動します。
  2. My Repositoryの下部にあるをクリックします。確認ポップアップが表示されます。
  3. ［削除］をクリックします。
認可を削除するとどうなりますか？  

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

ただし、Webhookまたはサブスクリプションは削除されません。認可の実行時に作成されたWebhookまたはサブスクリプションを削除する場合は、GitHubの設定に移動し、該当ワークスペースのWebhook作成を無効にしてください。  
組織のリポジトリーでは、組織のリソースにアクセスするために、組織の所有者が当社のOAuthアプリへのアクセスを許可する認可が必要です。次の手順に従ってください。
また、この解決策は以前にもお客様にご案内しているため、この回答をピン留めしてください。