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に貼り付けます。

きめ細かなパーソナルアクセストークンの生成

  1. GitLabで［設定］に移動します。
  2. ［ユーザー設定］を選択し、［パーソナルアクセストークン］をクリックします。
  3. ［自分がメンバーになっているすべてのグループとプロジェクト］のラジオボタンを選択します。
  4. ［リソース権限の追加］で、［グループとプロジェクト］タブを選択します。
  5. パーソナルアクセストークンを生成するため、以下の権限を有効にします。
    1. リポジトリー。
      1. ブランチ：読み取り
      2. コミット：読み取り
      3. マージリクエスト：読み取り
    2. プロジェクト計画。
      1. 作業項目：読み取り、更新、作成
    3. 連携。
      1. Webhook：読み取り、更新、削除
        メモ：この権限は、連携を設定するワークスペース所有者にのみ適用されます。
    4. プロジェクト。
      1. プロジェクト：読み取り
    5. CI/CD。
      1. パイプライン：読み取り
  6. 次に、［リソース権限の追加］で［ユーザー権限］タブに移動します。
  7. パーソナルアクセストークンを生成するため、以下の権限を有効にします。
  8. システムアクセス。
    1. ユーザー：読み取り
  9. プロジェクト。
    1. プロジェクト：読み取り
  10. 権限を有効にした後、［トークンを生成］をクリックします。

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

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

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

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

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

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

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

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

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

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

プロジェクトをリポジトリーに関連付ける際に、「課題プロジェクト」として指定できます。指定すると、以後リポジトリーに追加されるすべての課題が自動的に同期されます。
  1. ［GitLab］に移動します。
  2. リポジトリーをワークスペースに関連付けます。
  3. ［プロジェクトを関連付ける］ボタンをクリックします。プロジェクト一覧が表示されます。
  4. プロジェクトを選択します。
  5. ［バグのみ同期］を有効にするには、切り替えスイッチをクリックします。（1つのリポジトリーに複数のプロジェクトを関連付けることはできますが、［バグのみ同期］に指定できるプロジェクトは1件のみです。）
  6. ［更新］をクリックします。
GitLabで設定した見積もりポイントは、Zoho Sprintsで最も近いポイントに同期されます。

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

作業項目のステータスは、Zoho Sprintsの［未完了］または［完了］のステータスに関連付けられます。

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

Sprintsで作業項目を作成するときに、GitLabにもデータを作成できます。項目の作成画面では、その作業項目をGitLabアカウントに追加できます。データは同期され、SprintsとGitLab間で相互に連携できます。

項目の双方向同期

  1. 件名
  2. 説明
  3. コメント
  4. 重み（見積もりポイント）
  5. 開始日
  6. 終了日
  7. 担当者
Notes
  1. 項目の作成画面には、［バグのみ同期］が有効になっているリポジトリーだけが表示されます。
  2. Sprintsで設定した見積もりポイントは、GitLabで最も近いポイントに同期されます。
  3. 作業項目のステータスは、GitLabの［未完了］または［完了］のステータスに関連付けられます。

Zoho Sprintsのクイックコマンド

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

作業項目のタグ付けは、マージリクエストの［説明］項目からのみ行えます。

構文 
例
目的
#workitem #<プロジェクトの接頭語>- <i/I><項目番号>
例：#SP-i30
作業項目IDを表します。
#comment #workitemid #comment <メッセージ1> #comment <メッセージ2>
例：#SP-I15 #comment 本日中に最終ビルドを共有してください。 #comment 既存の問題を修正し、ローカルビルドを更新してください。

メモ。
1つの作業項目に複数のコメントを追加できます。
作業項目にコメントを追加します。
#status #workitemid #status <ステータス名>
例1：#SP-i20 #status Done
例2：#SP-i20 #status To_be_Tested

メモ。
1. ステータス名が複数の単語で構成される場合は、アンダースコアで区切ります。
2. ステータスでは大文字と小文字が区別されません。
作業項目のステータスを更新します。
#priority #workitemid #priority <優先度名>
例1：#SP-i40 #priority Critical
例2：#SP-i42 #priority Should_be

メモ。
1. 優先度名が複数の単語で構成される場合は、アンダースコアで区切ります。
2. 優先度では大文字と小文字が区別されません。
作業項目の優先度を更新します。
#time #workitemid #time <時間>h <分>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 要件を一覧にする #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 要件を一覧にする #priority High #time 5h 3m #status In_progress

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


マージリクエスト：クイックコマンドによる項目の自動完了

クイックコマンドを使用すると、マージリクエストから作業項目を直接更新できます。マージリクエストの説明に、#接頭語付きの項目ID #status <実際のステータス>の形式でクイックコマンドを入力します。例：'#SP-I1 #status done'。（接頭語付きの項目IDを取得する方法はこちら）。 これにより、作業項目がマージリクエストに関連付けられ、要求がマージされると項目のステータスが自動的に完了に更新されます。開発状況と作業状況を同期しながら、時間を節約できます。作業項目は、マージリクエストの処理の一環として一貫して更新されます。
 
マージリクエストがマージされると、作業項目に対してステータスコマンドが処理され、該当するステータスに更新されます。ステータス更新の実行者には、マージリクエストを開始したユーザーが記録されます。この情報は監査ログに記録されます。
 
Notes
メモ：
  1. マージリクエストを通じてステータスが更新されると、ユーザーにフィード通知が送信されます。
  2. マージリクエストの説明を編集することで、新しい作業項目を関連付けることができます。
  3. マージリクエストの説明内のクイックコマンドでは、関連付けた項目を元に戻すことはできません。項目の詳細ページにある［マージリクエスト］タブから削除できます。

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

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

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

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

接頭語付きの作業項目IDをコピーするには

プロジェクトの接頭語とIDを手動で指定するのは手間がかかります。作業項目の詳細ページから作業項目IDをコピーし、コミットメッセージやマージリクエストのコメントに貼り付けることができます。
  1. プロジェクトに移動します。
  2. 項目を選択します。
  3. 項目の詳細ページで、プロジェクト名の接頭語にカーソルを合わせます。
  4. ［接頭語付きIDをコピー］を選択します。

コミットとマージリクエストの削除

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

コマンドの実行権限

コメントの追加

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

工数の記録

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

優先度の更新

  1. 優先度にスペースが含まれる場合は、クイックコマンド内で「_」を使用して区切ります。例：#SP-L1 #priority low_risk。優先度では大文字と小文字は区別されません。
  2. 作業項目の優先度を更新するには、プロジェクトの有効なユーザーである必要があります。
  3. 作業項目の優先度を更新するには、管理者、共同管理者、またはプロジェクト管理者である必要があります。
  4. 指定する優先度名は、プロジェクトに登録されている必要があります。
  5. 有効なスプリント、今後のスプリント、またはバックログ内の作業項目に対してのみ、優先度を更新できます。
  6. 完了ステータスの作業項目の優先度は更新できません。

ステータスの更新

  1. ステータスにスペースが含まれる場合は、クイックコマンド内で「_」を使用して区切ります。例：#SP-L1 #status to_do。ステータスでは大文字と小文字は区別されません。
  2. 作業項目のステータスを更新するには、プロジェクトの有効なユーザーである必要があります。
  3. 作業項目のステータスを更新できるのは、スプリントの所有者、担当者、管理者、マネージャー、またはスプリントの作成者です。
  4. 指定するステータス名は、プロジェクトに登録されている必要があります。
  5. 有効なスプリント内の作業項目に対してのみ、ステータスを更新できます。

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を無効にします。