GitLab連携

GitLab連携

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

Zoho SprintsでGitLabのリポジトリを管理できます。リポジトリを関連するプロジェクトに対応付け、作業項目の詳細ページでコミットやマージ要求を添付できます。

情報
アクセス制御:ワークスペースの所有者が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. プロジェクトを選択し、[更新]をクリックします。
ワークスペースのリポジトリに関連付けられるプロジェクトは、最大50件です。

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

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

指定したプロジェクトには課題のみが同期されるため、すべての作業項目は標準の作業項目の種類「BUG」で作成されます。

作業項目のステータスは、Zoho Sprintsの未完了と完了のステータスに対応付けられます。

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

Sprintsで作業項目を作成する際に、GitLabにも同時にデータを作成できます。作業項目の作成画面では、その作業項目をGitLabアカウントに追加できます。これによりデータが同期され、Sprintsとの双方向のやり取りがスムーズになります。

双方向で同期される項目

  1. タイトル
  2. 説明
  3. コメント
  4. 重み(見積もり指数)
  5. 開始日
  6. 終了日
  7. 担当者
メモ
  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
作業項目に工数を追加します。

メモ
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 <actual status>の形式でクイックコマンドを入力します。例:'#SP-I1 #status done'(接頭語付きのエンティティIDの取得方法をご確認ください)。これにより、作業項目がマージ要求に関連付けられ、要求がマージされると、作業項目のステータスが自動的にクローズに更新されます。開発状況と作業状況の整合性を保ちながら、時間を節約できます。作業項目はマージ要求の処理の一環として、一貫して更新されます。
 
マージ要求がマージされると、作業項目に対してステータスコマンドが処理され、指定されたステータスに更新されます。マージ要求を開始したユーザーが、ステータスを更新したユーザーとして扱われます。この情報は監査ログに記録されます。
 
メモ
メモ:
  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

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

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を無効にしてください。