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

チュートリアル: コンプライアンスパイプラインを作成する（非推奨）

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

この機能は、GitLab 17.3で非推奨となり、19.0で削除される予定です。代わりにパイプライン実行ポリシータイプを使用してください。これは破壊的な変更です。詳細については、移行ガイドを参照してください。

コンプライアンスパイプラインを使用すると、特定のコンプライアンス関連ジョブがグループ内のすべてのプロジェクトのパイプラインで確実に実行されるようにすることができます。コンプライアンスパイプラインは、コンプライアンスフレームワークを通じてプロジェクトに適用されます。

このチュートリアルでは、以下のことを行います:

  1. 新しいグループを作成します。
  2. コンプライアンスパイプラインの設定用の新規プロジェクトを作成します。
  3. 他のプロジェクトに適用するコンプライアンスフレームワークを設定します。
  4. 新規プロジェクトを作成し、コンプライアンスフレームワークを適用します。
  5. コンプライアンスパイプラインの設定と通常のパイプラインの設定を組み合わせます。

はじめる前

  • 新しいトップレベルグループを作成する権限が必要です。

新しいグループを作成

コンプライアンスフレームワークは、トップレベルグループで設定されます。このチュートリアルでは、以下のトップレベルグループを作成します:

  • 2つのプロジェクトが含まれています:
    • コンプライアンスパイプラインの設定を保存するためのコンプライアンスパイプラインプロジェクト。
    • コンプライアンスパイプラインの設定で定義されたジョブをパイプラインで実行する必要がある別のプロジェクト。
  • プロジェクトに適用するコンプライアンスフレームワークがあります。

新しいグループを作成するには:

  1. 左側のサイドバーの上部で、新規作成（ plus ）を選択し、新規グループを選択します。
  2. グループを作成を選択します。
  3. グループ名フィールドに、Tutorial groupと入力します。
  4. グループを作成を選択します。

新しいコンプライアンスパイプラインプロジェクトを作成します

これで、コンプライアンスパイプラインプロジェクトを作成する準備ができました。このプロジェクトには、コンプライアンスフレームワークが適用されたすべてのプロジェクトに適用するコンプライアンスパイプラインの設定が含まれています。

コンプライアンスパイプラインプロジェクトを作成するには:

  1. 左側のサイドバーで、検索または移動先を選択して、Tutorial groupグループを見つけます。
  2. 新規プロジェクトを選択します。
  3. 空のプロジェクトの作成を選択します。
  4. プロジェクト名フィールドに、Tutorial compliance projectと入力します。
  5. プロジェクトを作成を選択します。

Tutorial compliance projectにコンプライアンスパイプラインの設定を追加するには:

  1. 左側のサイドバーで、検索または移動先を選択して、Tutorial compliance projectプロジェクトを見つけます。

  2. ビルド > パイプラインエディタを選択します。

  3. パイプラインの設定を選択します。

  4. パイプラインエディタで、デフォルトの設定を以下のように置き換えます:

    ---
compliance-job:
  script:
    - echo "Running compliance job required for every project in this group..."

  5. 変更をコミットするを選択します。

コンプライアンスフレームワークを設定します

コンプライアンスフレームワークは、新しいグループで設定されます。

コンプライアンスフレームワークを設定するには:

  1. 左側のサイドバーで、検索または移動先を選択して、Tutorial groupグループを見つけます。
  2. セキュリティ > コンプライアンスセンターを選択します。
  3. ページで、フレームワークタブを選択します。
  4. 新規フレームワークを選択します。
  5. 名前フィールドに、Tutorial compliance frameworkと入力します。
  6. 説明フィールドに、Compliance framework for tutorialと入力します。
  7. **コンプライアンスパイプラインの設定 (オプション)**フィールドに、.gitlab-ci.yml@tutorial-group/tutorial-compliance-projectと入力します。
  8. 背景色フィールドで、お好みの色を選択します。
  9. フレームワークを追加を選択します。

便宜上、新しいコンプライアンスフレームワークをグループ内のすべての新しいプロジェクトのデフォルトに設定します:

  1. 左側のサイドバーで、検索または移動先を選択して、Tutorial groupグループを見つけます。
  2. セキュリティ > コンプライアンスセンターを選択します。
  3. ページで、フレームワークタブを選択します。
  4. Tutorial compliance frameworkを選択し、フレームワークを編集を選択します。
  5. デフォルトとして設定を選択します。
  6. 変更を保存を選択します。

新規プロジェクトを作成し、コンプライアンスフレームワークを適用します

コンプライアンスフレームワークの準備ができたので、グループにプロジェクトを作成すると、パイプラインでコンプライアンスパイプラインの設定が自動的に実行されるようになります。

コンプライアンスパイプラインの設定を実行するための新しいプロジェクトを作成するには:

  1. 左側のサイドバーで、検索または移動先を選択して、Tutorial groupグループを見つけます。
  2. 新規作成（ plus ）を選択し、新規プロジェクト/リポジトリを選択します。
  3. 空のプロジェクトの作成を選択します。
  4. プロジェクト名フィールドに、Tutorial projectと入力します。
  5. プロジェクトを作成を選択します。

プロジェクトページに、Tutorial compliance frameworkというラベルが表示されています。これは、グループのデフォルトのコンプライアンスフレームワークとして設定されているためです。

他のパイプラインの設定がない場合、Tutorial projectは、Tutorial compliance projectのコンプライアンスパイプラインの設定で定義されたジョブを実行できます。

Tutorial projectでコンプライアンスパイプラインの設定を実行するには:

  1. 左側のサイドバーで、検索または移動先を選択して、Tutorial projectプロジェクトを見つけます。
  2. ビルド > パイプラインを選択します。
  3. パイプラインを新規作成を選択します。
  4. パイプラインを新規作成ページで、パイプラインの実行を選択します。

パイプラインがtest（test）ステージングでcompliance-jobという名前のジョブを実行することに注目してください。よくできました。最初のコンプライアンスジョブを実行しました。

パイプラインの設定を組み合わせます

プロジェクトで独自のジョブとコンプライアンスパイプラインのジョブを実行する場合は、コンプライアンスパイプラインの設定とプロジェクトの通常パイプラインの設定を組み合わせる必要があります。

パイプラインの設定を組み合わせるには、通常のパイプラインの設定を定義し、コンプライアンスパイプラインの設定を更新して参照する必要があります。

通常のパイプラインの設定を作成するには:

  1. 左側のサイドバーで、検索または移動先を選択して、Tutorial projectプロジェクトを見つけます。

  2. ビルド > パイプラインエディタを選択します。

  3. パイプラインの設定を選択します。

  4. パイプラインエディタで、デフォルトの設定を以下のように置き換えます:

    ---
project-job:
  script:
    - echo "Running project job..."

  5. 変更をコミットするを選択します。

新しいプロジェクトパイプラインの設定をコンプライアンスパイプラインの設定と組み合わせるには:

  1. 左側のサイドバーで、検索または移動先を選択して、Tutorial compliance projectプロジェクトを見つけます。

  2. ビルド > パイプラインエディタを選択します。

  3. 既存の設定に、以下を追加します:

    include:
  - project: 'tutorial-group/tutorial-project'
    file: '.gitlab-ci.yml'

  4. 変更をコミットするを選択します。

通常のパイプラインの設定がコンプライアンスパイプラインの設定と組み合わされていることを確認するには:

  1. 左側のサイドバーで、検索または移動先を選択して、Tutorial projectプロジェクトを見つけます。
  2. ビルド > パイプラインを選択します。
  3. パイプラインを新規作成を選択します。
  4. パイプラインを新規作成ページで、パイプラインの実行を選択します。

パイプラインがtest（test）ステージングで2つのジョブを実行することに注目してください:

  • compliance-job
  • project-job

おめでとうございます。コンプライアンスパイプラインを作成および設定しました。

コンプライアンスパイプラインの設定例をさらにご覧ください。