运行 bash 脚本

本页面介绍如何配置 Cloud Build 以在构建步骤中运行 bash 脚本。如果您是刚接触 Cloud Build，请先阅读快速入门和构建配置概览。

您可以在构建步骤中运行 bash 脚本以配置多个工作流，其中包括：

• 在一个构建步骤中运行多个命令。
• 从文件系统读取。
• 在重试或条件等逻辑中构建。
• 输出到日志，例如运行 echo $VARNAME。

使用 script 字段

Cloud Build 提供了一个 script 字段，您可以使用该字段指定要在构建步骤中执行的 shell 脚本。script 字段接受单个字符串值。

您可以为字符串值添加一个 shebang 前缀，以指定要解读此脚本的 shell。例如，添加 #!/usr/bin/env bash 以指定 Bash shell。如果您未为脚本字符串添加 Shebang 前缀，则 Cloud Build 会使用 #!/bin/sh（即基本的 sh shell，而非 Bash shell）。

如果您在构建步骤中指定 script，则无法在同一步骤中指定 args 或 entrypoint。

以下代码段演示了 script 字段：

YAML

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

JSON

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

在 script 字段中使用替代变量

脚本不直接支持替换，但支持环境变量。您可以将替代变量映射到环境变量，可以一次性自动映射到环境变量中，也可以通过自行定义每个环境变量来手动映射。

自动替换地图

• 在 build 级别。如需将所有替代变量自动映射到环境变量（在整个构建过程中都会提供），请在构建级别将 automapSubstitutions 设置为 true 选项。例如，以下构建配置文件显示了用户定义的替代变量 $_USER 和映射到环境变量的默认替代变量 $PROJECT_ID：

  YAML

  steps:
  - name: 'ubuntu'
    script: |
      #!/usr/bin/env bash
      echo "Hello $_USER"
  - name: 'ubuntu'
    script: |
      #!/usr/bin/env bash
      echo "Your project ID is $PROJECT_ID"
  options:
    automapSubstitutions: true
  substitutions:
    _USER: "Google Cloud"
  

  JSON

  {
    "steps": [
      {
        "name": "ubuntu",
        "script": "#!/usr/bin/env bash echo 'Hello $_USER'"
      },
      {
        "name": "ubuntu",
        "script": "#!/usr/bin/env bash echo 'Your project ID is $PROJECT_ID'"
      }
    ],
    "options": {
      "automap_substitutions": true
    },
    "substitutions": {
      "_USER": "Google Cloud"
    }
  }
  

• 在步骤级别。如需自动映射所有替代变量并在一个步骤中将它们作为环境变量提供，请在该步骤中将 automapSubstitutions 字段设置为 true。在以下示例中，只有第二步将正确显示替换，因为这是唯一一个启用了自动替换映射的步骤：

  YAML

  steps:
  - name: 'ubuntu'
    script: |
      #!/usr/bin/env bash
      echo "Hello $_USER"
  - name: 'ubuntu'
    script: |
      #!/usr/bin/env bash
      echo "Your project ID is $PROJECT_ID"
    automapSubstitutions: true
  substitutions:
    _USER: "Google Cloud"
  

  JSON

  {
    "steps": [
      {
        "name": "ubuntu",
        "script": "#!/usr/bin/env bash echo 'Hello $_USER'"
      },
      {
        "name": "ubuntu",
        "script": "#!/usr/bin/env bash echo 'Your project ID is $PROJECT_ID'",
        "automap_substitutions": true
      }
    ],
    },
    "substitutions": {
      "_USER": "Google Cloud"
    }
  

  此外，您还可以将替代变量作为环境变量在整个构建中提供，然后在一个步骤中忽略它们。在构建级别将 automapSubstitutions 设置为 true，然后在要忽略替换的步骤中将同一字段设置为 false。在以下示例中，即使在构建级别启用了映射替换，也不会在第二步输出项目 ID，因为在该步骤中 automapSubstitutions 设置为 false：

  YAML

  steps:
  - name: 'ubuntu'
    script: |
      #!/usr/bin/env bash
      echo "Hello $_USER"
  - name: 'ubuntu'
    script: |
      #!/usr/bin/env bash
      echo "Your project ID is $PROJECT_ID"
    automapSubstitutions: false
  options:
    automapSubstitutions: true
  substitutions:
    _USER: "Google Cloud"
  

  JSON

  {
    "steps": [
      {
        "name": "ubuntu",
        "script": "#!/usr/bin/env bash echo 'Hello $_USER'"
      },
      {
        "name": "ubuntu",
        "script": "#!/usr/bin/env bash echo 'Your project ID is $PROJECT_ID'",
        "automap_substitutions": false
      }
    ],
    "options": {
      "automap_substitutions": true
    },
    },
    "substitutions": {
      "_USER": "Google Cloud"
    }
  

手动替换映射

您可以手动将替代内容映射到环境变量。每个环境变量都是使用 env 字段在步骤级别定义的，并且变量的范围仅限于定义它们的步骤。此字段采用键和值列表。

以下示例展示了如何将替代变量 $PROJECT_ID 映射到环境变量 BAR：

YAML

steps:
- name: 'ubuntu'
  env:
  - 'BAR=$PROJECT_ID'
  script: 'echo $BAR'

JSON

{
  "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 脚本（旧版）

警告 ：这是将 bash 脚本与 Cloud Build 搭配使用的旧方法。此方法将继续有效，但我们建议您使用使用 script 字段运行 bash 脚本的较新方法。

要使用 bash 映像运行 bash 命令，请指定 bash 作为构建步骤的 name，并在 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 入口点用于运行 gcloud 命令来查询 Cloud Build 以获取构建状态，从而列出状态为失败的构建。

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 文档。

后续步骤

• 了解如何手动启动构建。
• 了解如何使用触发器自动执行构建。
• 了解如何配置构建步骤顺序。
• 了解如何使用社区提供的构建器和自定义构建器。