トリガー ファイルを作成する

このページでは、Secure Source Manager でトリガー YAML ファイルを作成する手順について説明します。トリガーファイルを使用すると、Secure Source Manager リポジトリの push イベントと pull リクエスト イベントに基づいてビルドを自動化できます。

トリガーファイルに含めることができるフィールドについては、 トリガー ファイルのスキーマをご覧ください。

始める前に

  1. Secure Source Manager インスタンスを作成します
  2. Secure Source Manager リポジトリを作成します
  3. トリガー ファイルのスキーマを読んで、 トリガーファイルに含めることができるフィールドを確認します。

必要なロール

トリガーファイルの作成に必要な権限を取得するには、次の IAM ロールを付与するよう管理者に依頼してください。

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタム ロールや他の事前定義 ロールから取得することもできます。

Cloud Build 構成ファイルを作成する

Secure Source Manager トリガーファイルでは、トリガーごとにビルド構成ファイルを指定する必要があります。

ビルド構成ファイルには、Cloud Build が指定に基づいてタスクを実行するための指示が記述されています。たとえば、ビルド構成ファイルには、Docker イメージのビルド、パッケージ化、push を行う手順を設定できます。

ビルド構成ファイルは、ビルド元となるブランチに作成します。ビルド構成ファイルを作成するには、 ビルド構成ファイルを作成するの手順に沿って操作します。

トリガーファイルを作成する

トリガー構成ファイルは、リポジトリのデフォルト ブランチ に作成する必要があります。

トリガー構成ファイルを作成する手順は次のとおりです。

  1. ローカル リポジトリまたは Secure Source Manager ウェブ インターフェースで、デフォルト ブランチ に切り替えます。
  2. .cloudbuild/triggers.yaml という名前のファイルを作成します。

  3. .cloudbuild/triggers.yaml ファイルでトリガーを構成します。

    triggers:
    - name: TRIGGER_NAME
      project: PROJECT_ID
      configFilePath: CLOUD_BUILD_CONFIG_PATH
      eventType: EVENT_TYPE
      ignoredGitRefs: IGNORED_GIT_REFS
      includedGitRefs: INCLUDED_GIT_REFS
      serviceAccount: SERVICE_ACCOUNT
      includedFiles: INCLUDED_FILES
      ignoredFiles: IGNORED_FILES
      disabled: DISABLED_BOOL
      substitutions:
        _VARIABLE_NAME: VARIABLE_VALUE
        OVERRIDE_VARIABLE_NAME: OVERRIDE_VARIABLE_VALUE
    

    次のように置き換えます。

    • TRIGGER_NAME は、トリガーの名前に置き換えます。トリガー名に使用できるのは英数字とダッシュのみです。先頭または末尾にダッシュは使用できません。トリガー名は 64 文字未満にする必要があります。
    • PROJECT_ID は、Cloud Build を有効にした Google Cloud プロジェクト ID に置き換えます。このフィールドは省略可能です。デフォルトは Secure Source Manager プロジェクトです。
    • CLOUD_BUILD_CONFIG_PATH は、このトリガーに使用する Cloud Build ビルド構成ファイルのパスに置き換えます。このフィールドは省略可能です。デフォルト値は .cloudbuild/cloudbuild.yaml です。
    • EVENT_TYPE は、ビルドをトリガーするイベントタイプに置き換えます。オプションは次のとおりです。

      • push: 指定したブランチへの push でトリガーする
      • pull_request : 指定したブランチへの pull リクエストでトリガーする

      このフィールドは省略可能です。デフォルト値は push です。

    • INCLUDED_GIT_REFS は、ビルドをトリガーする Git 参照に一致する RE2 正規表現形式(省略可)に置き換えます。デフォルト値は空です。空の値は、制限がないことを示します。

    • IGNORED_GIT_REFS は、ビルドをトリガーしない Git 参照に一致する RE2 正規表現形式の正規表現(省略可)に置き換えます。デフォルト値は空です。空の値は、制限がないことを示します。ignoredGitRefs フィールドは、includedGitRefs フィールドの前にチェックされます。これらのフィールドの詳細については、 トリガー ファイルのスキーマをご覧ください。

    • SERVICE_ACCOUNT は、ビルドに使用する Cloud Build サービス アカウントに 形式 projects/PROJECT_ID/serviceAccounts/ACCOUNT で置き換えます。 ACCOUNT は、 サービス アカウントのメールアドレスまたは一意の ID に置き換えます。ベスト プラクティスとして、 ユーザー指定のサービス アカウントを構成します以前の Cloud Build サービス アカウントは、制限があるため使用できません。

    • INCLUDED_FILES は、ビルドをトリガーするファイルに一致する RE2 形式の正規表現(省略可)に置き換えます。

      変更されたファイルが ignoredFiles フィルタ フィールドに一致せず、変更されたファイルが includedFiles フィルタ フィールドに一致する場合、ビルドがトリガーされます。デフォルト値は空です。空の値は、制限がないことを示します。

    • IGNORED_FILES は、ビルドをトリガーしないファイルに一致する RE2 形式の正規表現(省略可)に置き換えます。

      commit 内の変更されたファイルがすべてこのフィルタ フィールドに一致する場合、ビルドはトリガーされません。デフォルト値は空です。空の値は、制限がないことを示します。

    • DISABLED_BOOL は、トリガーを無効にする場合は true、トリガーを有効にする場合は false に置き換えます。このフィールドは省略可能です。デフォルト値は false です。

    • VARIABLE_NAME は、トリガーファイルに導入する変数の名前に置き換えます。

    • VARIABLE_VALUE は、変数の値に置き換えます。

    • OVERRIDE_VARIABLE_NAME は、Secure Source Manager のデフォルトの置換変数名に置き換えます。使用可能な デフォルトの置換変数については、 トリガー ファイルのスキーマの置換をご覧ください。

    • OVERRIDE_VARIABLE_VALUE は、デフォルトの置換変数のデフォルト値をオーバーライドする値に置き換えます。

  4. トリガー構成ファイルをデフォルト ブランチに commit します。

    トリガーファイルが commit されると、Secure Source Manager はトリガーファイルの構成に基づいてビルドをトリガーします。

    Secure Source Manager は、次のタイプのイベントの構成ファイルと、関連する commit SHA または Git 参照を読み取ります。

    • push イベントの場合、Secure Source Manager は push が完了したときに commit SHA または Git 参照を読み取ります。
    • pull_request イベントの場合、Secure Source Manager は pull リクエストの変更が pull されたときに commit SHA または Git 参照を読み取ります。

ビルドのステータスを表示する

push イベントまたは pull リクエスト イベントによってビルドがトリガーされると、commit とビルドのステータスが Secure Source Manager ウェブ インターフェースに表示されます。

ビルドのステータスの値は次のとおりです。

  • 成功SUCCESS: ビルドが正常に完了しました。
  • 警告WARNING: ビルドを試行中に問題が発生しました。
  • failureFAILURE: 実行中にビルドが失敗しました。

トリガーファイルで構成されたトリガーからの成功ステータス チェックを要求するようにブランチ保護ルールを構成すると、ビルドが失敗した commit が重要なブランチにマージされないようにできます。ブランチ保護の詳細については、 ブランチ保護の概要をご覧ください。

push イベントのビルドステータスを表示する手順は次のとおりです。

  1. Secure Source Manager ウェブ インターフェースで、リポジトリに移動します。

    最新の push イベントでビルドがトリガーされた場合、ステータスが commit SHA の横に表示されます。ステータスの詳細を表示するには、ステータスをクリックします。

  2. 以前の commit のビルドステータスを表示するには、[Commits] を選択して commit 履歴を表示し、詳細を表示するステータスをクリックします。

pull リクエスト イベントのビルドステータスを表示する手順は次のとおりです。

  1. Secure Source Manager ウェブ インターフェースで、[Pull requests] をクリックします。
  2. 表示する pull リクエストをクリックします。

    pull リクエストによってビルドがトリガーされた場合は、 [All checks were successful] または [Some checks reported warnings] というタイトルのセクションが表示されます。

次のステップ