正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

VS Code拡張機能のCI/CDパイプライン

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

GitLabプロジェクトでCI/CDパイプラインを使用している場合、VS Code用GitLab Workflow拡張機能からCI/CDパイプラインを開始、監視、デバッグできます。Gitブランチでローカルに作業する場合、下部のステータスバーには次のいずれかが表示されます:

  • 最新のパイプラインのステータス。
  • No pipeline(パイプラインがまだ実行されていない場合)。

最新のパイプラインが失敗したことを示す、下部のステータスバー。

使用可能なステータスは次のとおりです:

  • パイプラインがキャンセルされました
  • パイプラインが失敗しました
  • パイプラインに合格しました
  • パイプラインが保留中です
  • パイプラインが実行中です
  • パイプラインがスキップされました

パイプライン情報を表示

この拡張機能を使用して、GitLabでCI/CDパイプラインを開始、監視、デバッグします。

前提要件:

  • プロジェクトでCI/CDパイプラインを使用している。
  • 現在のGitブランチにマージリクエストが存在する。
  • 現在のGitブランチの最新コミットにCI/CDパイプラインがある。

パイプライン情報を表示するには:

  1. VS Codeの下部ステータスバーで、パイプラインステータスを選択して、コマンドパレットにアクションを表示します。

  2. コマンドパレットで、目的のアクションを選択します:

    • Create New Pipeline From Current Branch(現在のブランチから新しいパイプラインを作成): 新しいパイプラインを開始する。
    • Cancel Last Pipeline(最後のパイプラインをキャンセル)
    • Download Artifacts from Latest Pipeline(最新パイプラインからアーティファクトをダウンロード): パイプラインアーティファクトをZIPまたはJSON形式でダウンロードします。
    • Retry Last Pipeline(最後のパイプラインを再試行)
    • View Latest Pipeline on GitLab(GitLabで最新のパイプラインを表示): ブラウザータブでパイプラインのページを開きます。

パイプラインアラートを表示

この拡張機能は、現在のブランチのパイプラインが完了すると、VS Codeにアラートを表示できます:

パイプラインの失敗を示すアラート

現在のGitブランチのアラートを表示するには:

  1. VS Codeの上部メニューで、コード > 設定 > 設定を選択します。
  2. 構成に応じて、ユーザーまたはWorkplace(ワークプレース)の設定を選択します。
  3. メインタブで、Extensions(拡張機能) > GitLab Workflowを選択して、この拡張機能の設定を表示します。
  4. Show Pipeline Update Notifications(パイプライン更新通知を表示)で、Show notification in VS Code when the pipeline status changes(パイプラインステータスが変更されたときにVS Codeに通知を表示する)チェックボックスをオンにします。

CI/CDジョブ出力

現在のブランチのCI/CDジョブの出力を表示するには:

  1. 左側の垂直メニューバーでGitLab Workflow tanuki )を選択して、拡張機能サイドバーを表示します。

  2. サイドバーで、For current branch(現在のブランチの場合)を展開して、最新のパイプラインを表示します。

  3. 目的のジョブを選択して、新しいVS Codeタブで開きます:

    合格、失敗を許可、および失敗しているCI/CDジョブを含むパイプライン。

    ダウンストリームパイプラインは、パイプラインの下に表示されます。ダウンストリームパイプラインジョブログを開くには:

    1. 矢印アイコンを選択して、ダウンストリームパイプラインの表示レベルを展開または折りたたむします。
    2. ダウンストリームパイプラインを選択します。ジョブログが新しいVS Codeタブで開きます。

GitLab CI/CDの設定をテストする

GitLab: Validate GitLab CI Configコマンドを使用して、プロジェクトのGitLab CI/CD構成をローカルでテストします。

  1. VS Codeで、.gitlab-ci.ymlファイルを開き、ファイルのタブがアクティブになっていることを確認します。
  2. コマンドパレットを開きます:
    • macOSの場合は、Command+Shift+Pキーを押します。
    • WindowsまたはLinuxの場合は、Control+Shift+Pキーを押します。
  3. コマンドパレットで、GitLab: Validate GitLab CI Configを検索し、Enterキーを押します。

拡張機能は、構成に問題が検出されたアラートを表示します。

マージされたGitLab CI/CD構成を表示

このコマンドを使用すると、すべてのインクルードと参照が解決された、マージされたCI/CD設定ファイルのプレビューを表示できます。

  1. VS Codeで、.gitlab-ci.ymlファイルを開き、ファイルのタブがアクティブになっていることを確認します。

  2. 右上にあるShow Merged GitLab CI/CD Configuration(マージされたGitLab CI/CD構成を表示)を選択します:

    マージされた結果を表示するアイコンを示すVS Codeアプリケーション。

VS Codeは、完全な情報を含む新しいタブ(.gitlab-ci (Merged).yml)を開きます。

CI/CD変数オートコンプリート

CI/CD変数オートコンプリートを使用して、探しているCI/CD変数をすばやく見つけます。

前提要件:

  • ファイルには、次のいずれかの名前が付けられています:
    • .gitlab-ci.yml
    • .gitlab-ciで始まり、.ymlまたは.yamlで終わる.gitlab-ci.production.ymlのようになります。

変数を自動補完するには:

  1. VS Codeで、.gitlab-ci.ymlファイルを開き、ファイルのタブがアクティブになっていることを確認します。

  2. 自動補完オプションを表示するには、変数の名前の入力を開始します。

  3. オプションを選択して使用します:

    文字列に表示されるオートコンプリートオプション