bash スクリプトの実行

このページでは、ビルドステップ内で bash スクリプトを実行するように Cloud Build を構成する方法について説明します。Cloud Build を初めて使用する場合は、最初にクイックスタートとビルド構成の概要をご覧ください。

ビルドステップ内で bash スクリプトを実行すると、次のような多数のワークフローを構成できます。

• 1 つのビルドステップで複数のコマンドを実行する。
• ファイル システムからの読み取りを行う。
• 再試行や条件などのロジックを組み込む。
• ログへの出力を行う（例: echo $VARNAME の実行）。

script フィールドの使用

Cloud Build には、ビルドステップで実行するシェル スクリプトを指定するために使用できる script フィールドが用意されています。script フィールドは 1 つの文字列値を取ります。スクリプトを解釈するシェルを指定するには、文字列の値の先頭に シバン を追加します。スクリプト文字列の先頭にシバンを指定しないと、Cloud Build は Bash シェルではなく、基本的な Shell シェルである #!/bin/sh を使用します。

ビルドステップで script を指定する場合、同じステップで args または entrypoint を指定することはできません。

次のスニペットは、script フィールドを示しています。

YAML

steps:
- name: ubuntu
  script: echo hello
- name: python
  script: |
    #!/usr/bin/env python
    print('hello from python')

JSON

{
  "steps": [
  {
    "name": "ubuntu",
    "script": "echo hello"
  },
  {
    "name": "python",
    "script": "#!/usr/bin/env python\nprint('hello from python')\n"
  }
  ]
}

script フィールドでの置換の使用

script フィールドは代入変数をサポートしていません。置換を使用する場合は、これらを環境変数として追加します。

次のスニペットは、プロジェクト ID を使用して環境変数を設定する方法を示しています。

build {
  steps {
    name: "ubuntu"
    env: "BAR=${PROJECT_ID}"
    script: "echo $BAR"
  }
}

ディスクでの bash スクリプトの実行

bash スクリプトをファイルに保存している場合は、このファイルをビルドソースとともに保存し、ビルド構成ファイル内でスクリプト ファイルを参照します。

YAML

steps:
- name: 'bash'
  args: ['./myscript.bash']

JSON

{
  "steps": [
  {
    "name": "bash",
    "args": [
      "./myscript.bash"
     ]
  }
  ]
}

使用しているイメージのデフォルトのエントリ ポイントが bash スクリプトでない場合、bash スクリプトを使用するには、bash を指す entrypoint フィールドを追加します。

YAML

steps:
- name: 'gcr.io/cloud-builders/gcloud'
  entrypoint: 'bash'
  args: ['tools/myScript.sh','--foo']

JSON

{
  "steps": [
  {
    "name": "gcr.io/cloud-builders/gcloud",
    "entrypoint": "bash",
    "args": [
      "tools/myScript.sh",
      "--foo"
    ]
  }
  ]
}

インライン bash スクリプトの実行（レガシー）

警告: これは、Cloud Build で bash スクリプトを使用するレガシーな方法です。この方法は引き続き機能しますが、script フィールドを使用して bash スクリプトを実行する新しい方法を使用することをおすすめします。

bash イメージを使用して bash コマンドを実行するには、ビルドステップの name として bash を指定し、args フィールドにコマンドを指定します。

YAML

steps:
- name: 'bash'
  args: ['echo', 'I am running a bash command']

JSON

{
  "steps": [
    {
      "name": "bash",
      "args": [
        "echo",
        "I am running a bash command"
       ]
    }
  ]
}

使用しているイメージに bash があらかじめパッケージ化されているものの bash がデフォルトのエントリ ポイントでない場合は、bash を指す entrypoint フィールドを追加します。以下の例では、bash エントリ ポイントを使用して、Cloud Build にビルド ステータスをクエリし、失敗したステータスを含むビルドを一覧表示する gcloud コマンドを実行します。

YAML

steps:
- name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
  entrypoint: 'bash'
  args:
  - '-eEuo'
  - 'pipefail'
  - '-c'
  - |-
    gcloud builds list > builds.txt
    while read line; do
        if grep -q "FAILURE" <<< "$line"; then
            echo "$line"
        fi
    done < builds.txt

JSON

{
  "steps": [
  {
    "name": "gcr.io/google.com/cloudsdktool/cloud-sdk",
    "entrypoint": "bash",
    "args": [
      "-eEuo",
      "pipefail",
      "-c",
      "gcloud builds list > builds.txt\nwhile read line; do\n    if grep -q \"FAILURE\" <<< \"$line\"; then\n        echo \"$line\"\n    fi\ndone < builds.txt"
    ]
  }
  ]
}

上のコードの -c フラグは、複数行コマンドを実行するために使用します。-c の後に渡した文字列はすべてコマンドとして扱われます。-c を使用した bash コマンドの実行の詳細については、bash のドキュメントをご覧ください。

次のステップ

• ビルドを手動で開始する方法を学習する。
• トリガーを使用してビルドを自動化する方法を学習する。
• ビルドステップの順序を構成する方法を学習する。
• コミュニティ提供のビルダーとカスタム ビルダーを使用する方法を学習する。