ソース リポジトリでコードを手動でビルドする

このページでは、ソース リポジトリでコードをビルドする手動トリガーを作成する方法について説明します。手動トリガーを使用してビルドを手動で呼び出すことができます。また、ビルドを実行する前に、呼び出し時に定義した置換変数の値をオーバーライドできます。手動トリガーのスケジュールを設定して、特定の時間に自動的に実行することもできます。

gcloud CLI または Cloud Build API を使用してビルドを手動で開始する方法については、手動でのビルドの開始をご覧ください。

始める前に

  • Enable the Cloud Build API.

    Enable the API

  • ソースコードを準備します。

手動トリガー

手動トリガーを使用すると、接続されたリポジトリでトリガーを呼び出した場合にのみ実行されるビルドを設定できます。たとえば、ステージング環境または本番環境にソースコードをデプロイするパイプラインを作成するとします。ワークフローを自動化することもできますが、ビルドの実行は手動でのみ行うものとします。そこで、手動トリガーを定義します。

手動トリガーでは、次の手順でビルドを手動で呼び出します。

  • 指定されたブランチまたはタグが付いた、ホストされているリポジトリからソースコードをフェッチします。
  • ビルドを実行するたびに手動で渡す必要がなくなるよう置換を使用してビルドをパラメータ化します。
  • ビルドを起動する前の呼び出し時に、定義された置換変数の値をオーバーライドします。

ホストされているリポジトリではなく、ローカル作業ディレクトリからビルドを実行するか、またはトリガーを作成せずにビルドを送信するには、作業ディレクトリで次の gcloud コマンドを実行します。

gcloud builds submit --config BUILD_CONFIG SOURCE_CODE

ここで

  • BUILD_CONFIG は、ビルド構成ファイルへのパスです。
  • SOURCE_CODE は、パスまたは URL のソースコードです。

gcloud コマンドを使用してローカル ディレクトリでビルドを手動で開始する方法についての詳細は、手動でのビルドの開始をご覧ください。

手動トリガーの作成

コンソール

手動トリガーを作成する手順は、次のとおりです。

  1. [トリガー] ページを開く

    [トリガー] ページを開く

  2. ページ上部でプロジェクトを選択し、[開く] をクリックします。

  3. [トリガーを作成] をクリックします。

  4. 次のトリガー設定を入力します。

    • 名前: トリガーの名前。

    • リージョン: トリガーのリージョンを選択します。

      • リージョンとしてグローバルを選択した場合、Cloud Build はビルドを実行するためにデフォルトのプールを使用します。
      • 非グローバル リージョンを選択して、トリガーに関連付けられたビルド構成ファイルでプライベート プールを指定すると、Cloud Build はプライベート プールを使用してビルドを実行します。この場合、トリガーで指定するリージョンは、プライベート プールを作成したリージョンと一致する必要があります。
      • 非グローバル リージョンを選択し、トリガーに関連付けられたビルド構成ファイルでプライベート プールが指定されていない場合、Cloud Build はデフォルトのプールを使用してトリガーと同じリージョンでビルドを実行します。

    • 説明（省略可）: トリガーの説明。

    • イベント: [手動呼び出し] を選択してトリガーを設定すると、手動で呼び出されたときにのみビルドが実行されます。

    • ソース: 手動トリガーの実行時にビルドするリポジトリを選択します。ソースとして [第 1 世代] または [第 2 世代] を指定できます。

    • リビジョン: 手動トリガーの実行時にビルドするブランチまたはタグを選択します。

    • ブランチ: このブランチ上でビルドするトリガーを設定します。リテラル値を指定する必要があります。正規表現は現在サポートされていません。

    • タグ: このタグでビルドするトリガーを設定します。リテラル値を指定する必要があります。正規表現は現在サポートされていません。

    • 構成: ビルドに使用するリモート リポジトリにあるビルド構成ファイルを選択するか、インライン ビルド構成ファイルを作成します。

      • タイプ: ビルドに使用する構成のタイプを選択します。
        • Cloud Build 構成ファイル（yaml または json）: 構成にビルド構成ファイルを使用します。
        • Dockerfile: 構成には Dockerfile を使用します。

      • 場所: 構成の場所を指定します。

        • リポジトリ: 構成ファイルがリモート リポジトリにある場合は、ビルド構成ファイル、Dockerfile ディレクトリの場所、または Bullpack のディレクトリを指定します。ビルド構成タイプが Dockerfile または buildpack の場合、ビルドするイメージの名前と、必要に応じてビルドのタイムアウトを指定する必要があります。Dockerfile または buildpack イメージ名を指定すると、ビルドが実行される docker build または pack コマンドのプレビューが表示されます。
        • インライン: 構成オプションとして Cloud Build 構成ファイル（yaml または json）を選択した場合、インライン ビルド構成を指定できます。Google Cloud コンソールで [エディタを開く] をクリックして、YAML または JSON 構文でビルド構成ファイルを書き込みます。[完了] をクリックしてビルド構成ファイルを保存します。

  5. [作成] をクリックして手動トリガーを作成します。

gcloud

フラグの完全なリストについては、手動トリガーの作成方法の gcloud リファレンスをご覧ください。

手動トリガーの実行

コンソール

Google Cloud コンソールを使用して手動トリガーを実行するには、以下の手順に従います。

  1. Google Cloud Console で [トリガー] ページを開きます。

    [トリガー] ページを開く

  2. リストからトリガーを見つけます。

  3. [トリガーを実行] をクリックします。

    [トリガーを実行] をクリックすると、右側に [トリガーを実行] ウィンドウ ペインが表示されます。ブランチ名、タグ名、置換変数などのフィールドを指定した場合は、呼び出し時にこれらのフィールドをオーバーライドできます。

    置換に新しい変数値を指定した場合、[トリガーを実行] をクリックしてビルドを実行します。

    スケジュールで手動トリガーを実行するには、ビルドのスケジュール設定をご覧ください。

gcloud

gcloud コマンドライン ツールを使用して手動トリガーを実行するには、次のコマンドを実行します。

      gcloud builds triggers run TRIGGER_NAME \
         --region=REGION \
         --branch=BRANCH_NAME \
         --substitutions=SUBSTITUTION_VAR=SUBSTITUTION_VALUE

ここで

  • TRIGGER_NAME はトリガーの名前です。
  • REGION はトリガーのリージョンです。
  • BRANCH_NAME はブランチの名前です。--tag を使用してタグを指定することも、--sha を使用して commit ID を指定することもできます。
  • [省略可] SUBSTITUTION_VAR は、置換値の変数名です。
  • [省略可] SUBSTITUTION_VALUE は、置換変数に関連付けられた値です。

スケジュールで手動トリガーを実行するには、ビルドのスケジュール設定をご覧ください。

次のステップ