GitLab連携

GitLab連携

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

Zoho SprintsでGitLabリポジトリーを管理できます。リポジトリーを関連するプロジェクトにマッピングし、作業項目の詳細ページでコミットやプルリクエストを添付できます。

Info
アクセス制御：ワークスペース所有者によるGitLabアカウントの認証
  1. 右上にある歯車アイコンをクリックします。設定ウィンドウが表示されます。
  2. ［その他］（［マーケットプレイス］内）をクリックします。
  3. GitLabアプリの［設定］をクリックします。
  4. 規約に同意します。
  5. ［クラウド］または［セルフマネージド］を選択します。
  6. ［クラウド］をクリックすると、GitLab.comにリダイレクトされます。
［セルフマネージド］をクリックした場合は、セルフマネージド版からURLとアクセストークンをコピーして貼り付け、［設定］をクリックします。

GitLabのセルフマネージド版からのアカウントの設定

  1. GitLabのセルフマネージド版で、右上の［設定］に移動します。
  2. 左パネルの［アクセストークン］に移動します。
  3. apiスコープとread_userスコープを有効にし、新しいアクセストークンを作成します。
  4. GitLabからZoho Sprintsにアクセストークンをコピーして貼り付けます。

マイリポジトリー：個人リポジトリーには、GitLabで管理者アクセス権を持つすべてのリポジトリーが表示されます。

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

リポジトリーのワークスペースリポジトリーへのマッピング

  1. 右上にある歯車アイコンをクリックします。設定ウィンドウが表示されます。
  2. ［その他］（［マーケットプレイス］内）を選択します。
  3. ［GitLab］を選択します。

マイリポジトリーのリポジトリー一覧の表示

  1. リポジトリー名にカーソルを合わせます。
  2. リポジトリー名の横にある矢印アイコンをクリックし、リポジトリーをワークスペースにマッピングします。

プロジェクトのワークスペースリポジトリーへの関連付け

ワークスペースリポジトリーにプロジェクトを関連付けることができます。

  1. GitLabに移動します。
  2. ワークスペースリポジトリーのリポジトリー一覧を表示します。
  3. ［プロジェクトの関連付け］ボタンをクリックします。プロジェクトの一覧が表示されます。
  4. プロジェクトを選択し、［更新］をクリックします。
ワークスペースリポジトリーに関連付けられるプロジェクトは50件までです。

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

プロジェクトをリポジトリーにマッピングする際に、そのプロジェクトを「課題プロジェクト」として指定できます。これにより、リポジトリーに今後追加されるすべての課題が自動的に同期されます。

  1. GitLabに移動します。
  2. リポジトリーをワークスペースにマッピングします。
  3. ［プロジェクトの関連付け］ボタンをクリックします。プロジェクトの一覧が表示されます。
  4. プロジェクトを選択します。
  5. トグルスイッチをクリックして、［バグのみ同期］を有効にします。（リポジトリーに複数のプロジェクトを関連付けることはできますが、［バグのみ同期］に指定できるプロジェクトは1件のみです。）
  6. ［更新］をクリックします。
GitLabで定義した見積もりポイントは、Zoho Sprints内の最も近いポイントに同期されます。

指定したプロジェクトにはバグのみが同期されるため、すべての作業項目は初期設定の作業項目タイプ「BUG」で作成されます。

作業項目のステータスは、Zoho Sprintsの未完了ステータスと完了ステータスにマッピングされます。

作業項目のGitLabリポジトリーへの同期

Sprintsで作業項目を作成する際に、同時にGitLabにもデータを作成できます。項目作成画面には、その作業項目をGitLabアカウントに追加する機能が含まれています。これによりデータが同期され、Sprintsとの間で連携できます。

Sprintsから同期される項目

タイトル、説明、コメント、ウェイト（見積もりポイント）

Notes
  1. 項目の作成ウィンドウには、［バグのみ同期］が有効になっているリポジトリーのみが表示されます。
  2. Sprintsで定義した見積もりポイントは、GitLab内の最も近いポイントに同期されます。
  3. 作業項目のステータスは、GitLabの未完了ステータスと完了ステータスにマッピングされます。

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
作業項目に作業時間を記録します。

Notes
GitLabユーザーのメールアドレスは、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 List out the requirements #priority High #time 5h 3m #status In_progress

作業項目にコメントと記録工数が追加され、ステータスと優先度も更新されます。


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

構文 例 実行結果
#workitemid,#workitemid,#workitemid #comment <message> #priority <priority_name> #time <>h <>m #status <status_name> #SM-I34, #SM-I45, #SM-I54 #comment List out the requirements #priority High #time 5h 3m #status In_progress

3件すべての作業項目にコメントと記録工数が追加され、ステータスと優先度が更新されます。


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

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

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

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

作業項目IDのコピー方法

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

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

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

コマンドの利用権限

コメントの追加

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

工数の記録

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

優先度の更新

  1. 作業項目の優先度を更新するには、プロジェクトの有効なユーザーである必要があります。
  2. 作業項目の優先度を更新するには、管理者、共同管理者、またはプロジェクトマネージャーである必要があります。
  3. 指定する優先度名は、プロジェクト内に存在する優先度である必要があります。
  4. 作業項目の優先度を更新できるのは、進行中および今後のスプリント内の作業項目と、バックログ内の作業項目のみです。
  5. 作業項目がクローズ済みステータスの場合、その優先度は更新できません。

ステータスの更新

  1. 作業項目のステータスを更新するには、プロジェクトの有効なユーザーである必要があります。
  2. 作業項目のステータスを更新するには、スプリントの所有者、担当者、管理者、マネージャー、またはスプリント作成者である必要があります。
  3. 指定するステータス名は、プロジェクト内に存在するステータスである必要があります。
  4. 作業項目のステータスを更新できるのは、進行中のスプリント内のみです。

CI/CD

GitLabにはCI/CDオプションがあります。このオプションは、関連付けられたリポジトリーでのみ利用できます。すべてのビルド更新情報がここに表示されます。パイプライン、ブランチ、そのステージやジョブを表示できます。

CI/CDでGitLabにアクセスするには：
  1. Zoho Sprintsにサインインします。
  2. 左側のナビゲーションパネルで［CI/CD］オプションを選択します。［CI/CD］のタブが表示されます。
  3. ［GitLab］タブを選択します。
  4. 関連付けられたリポジトリーを選択します。リポジトリー内のパイプラインとコミットが表示されます。
  5. パイプラインにカーソルを合わせて、詳細とステージを表示します。
  6. 各詳細を表示するには、リンクをクリックします。
特定のコミットをクリックすると、関連付けられた作業項目も表示できます。

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

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

プロジェクト関連付けフォームから
  1. ［GitLab］に移動します。
  2. ワークスペースリポジトリーで［プロジェクトを関連付ける］ボタンをクリックします。
  3. プロジェクト関連付けフォームで、プロジェクトの選択を解除します。
  4. ［更新］をクリックします。
ワークスペースリポジトリーから直接
  1. ［GitLab］に移動します。
  2. 表示されているプロジェクト数をクリックします。
  3. 関連付けを解除するプロジェクトにカーソルを合わせます。
  4. ［プロジェクトを削除］をクリックします。

チームからのリポジトリーの削除

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

リポジトリーをワークスペースから削除するとどうなりますか？

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

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

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

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

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