外部コミットステータス

外部コミットステータスを使用すると、Jenkins、CircleCI、カスタムデプロイツールなどの外部CI/CDシステムをGitLabパイプラインと統合できます。外部システムはコミットステータスをGitLabにポストし、ステータスの結果はマージリクエストとコミットビューのCI/CDジョブとともに表示されます。

外部システムがCommits APIを使用してコミットステータスをポストすると、GitLabはこれらのステータスを既存のパイプラインに追加するか、それらを含める新しいパイプラインを作成して処理します。

パイプラインの選択

外部システムからコミットステータスをポストすると、検索または作成のアプローチが使用されます:

1. GitLabは、指定されたコミットSHAとrefsの最新のnon-archived CIパイプラインを検索します。pipeline_idパラメータを含めることで、パイプラインを直接検索することもできます。
2. GitLabが適切なパイプラインを見つけた場合、新しいジョブステータスをそのパイプラインに追加します。既存のパイプラインに追加されたジョブの場合、CI_PIPELINE_SOURCEはパイプラインソース（pushやmerge_request_eventなど）と一致します。
3. 適切なパイプラインが存在しない場合、GitLabはジョブを含める新しいパイプラインを作成します。新しいパイプラインの場合、CI_PIPELINE_SOURCEはexternalです。

外部ジョブステータスは、他のGitLab CI/CDステージとは別に、パイプラインのexternalステージに表示されます。

ジョブの更新と再試行

外部システムからコミットステータスをポストする場合:

• 同じname userおよびshaを持つrunningまたはpendingジョブがターゲットパイプラインにすでに存在する場合、GitLabはそのステータスを更新します。
  • 別のユーザーが同じnameでジョブを更新すると、ジョブが再試行されます。これにより、新しいジョブが作成され、現在のパイプラインから古いジョブが非表示になります。
• nameが同じでstatusが異なる（たとえば、failedとマークされたジョブにsuccessを送信する）runningまたはpendingでないジョブを再試行できます。これにより、新しいジョブが作成され、現在のパイプラインから古いジョブが非表示になります。
• 異なる外部サービスは、一意のジョブnameを使用して、同じSHAとパイプラインにジョブを追加できます。

SHA/refsの組み合わせで更新がすでに進行中の場合、409エラーが返されます。このエラーを処理するには、リクエストを再試行してください。

トラブルシューティング

マージリクエストに外部ステータスが表示されない

外部CIステータスがマージリクエストパイプラインに表示されない場合:

1. 同じコミットに対してマージリクエストとブランチパイプラインの両方が実行されているかどうかを確認します。
2. ワークフロールールが重複するパイプラインを防いでいることを確認してください。
3. 外部システムが正しいrefsにポストしていることを確認します。
4. コミットがマージリクエストに関連付けられている場合は、APIコールがマージリクエストのソースブランチ内のコミットを対象としていることを確認してください。

詳細については、重複するパイプラインの回避を参照してください。