GitHub 操作运行程序 buildspec 参考 - Amazon CodeBuild
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

GitHub 操作运行程序 buildspec 参考

本主题包含 GitHub 操作运行程序属性的 buildspec 参考。

步骤

可选的序列。步骤用于在 CodeBuild 中运行命令和操作。有关更多信息,请参阅Amazon CodeBuild 中的 GitHub Action 运行程序

注意

各个构建阶段会支持一系列 commandssteps,但同一阶段不会同时支持上述二者。

每个构建步骤都包含以下属性。

id

可选。步骤的标识符,可用于从其他上下文中引用该步骤。

if

可选。一种条件语句,可用于阻止运行步骤,除非满足条件。此语句可以使用任何支持的上下文,例如引用 CodeBuild 中的环境变量以及表达式

name

可选。步骤的名称。如果未指定名称,则名称将默认使用 run 命令中指定的文本。

uses

针对该步骤运行的操作。有些操作要求您使用 with 设置输入。参考该操作的自述文件以确定需要哪些输入。有关更多信息,请参阅我可以使用哪些 GitHub Action?

如果已在构建阶段指定 uses,则不能将其与 run 一起使用。

注意

建议您提供正在使用的操作版本。您可以通过指定 Git 引用、SHA 或 Docker 标签来执行此操作。有关更多信息,请参阅 steps.uses 语法

run

运行命令行程序的命令。这些命令可以是单行命令,也可以是多行命令。默认情况下,这些命令使用非登录 shell 运行。要选择其他 shell,请使用 shell

如果已在构建阶段指定 run,则不能将其与 uses 一起使用。

shell

可选。为此序列指定的 shell。有关支持的 shell 参数,请参阅 steps.shell。如果未指定,则使用的 shell 是 bash。如果 bash 不可用,则使用 sh。

with

可选。由操作定义的输入参数的映射。每个参数由一个键/值对组成。

with.args

可选。定义 Docker 容器输入的字符串。

with.entrypoint

可选。为 Dockerfile 指定的 Docker 入口点。

env

可选。为要在此环境中使用的步骤指定的变量。

continue-on-error

可选。布尔值,用于指示是否可以忽略此步骤序列的故障。

false

默认值。如果此步骤序列失败,则构建失败。

true

如果此步骤序列失败,则构建仍然可能成功。

timeout-minutes

可选。该步骤在终止之前可以运行的最大分钟数。默认情况下,不会设置超时。如果步骤超时超过构建超时,则该步骤将在达到构建超时时停止。

以下是使用 Super-Linter GitHub 操作的示例:

version: 0.2 phases: build: steps: - name: Lint Code Base uses: github/super-linter@v5 env: VALIDATE_ALL_CODEBASE: true USE_FIND_ALGORITHM: true FILTER_REGEX_INCLUDE: '/github/workspace/buildspec.yml'