NAVNavbar.
yaml.

CircleCI 2.1 Reference

概述

这document is a reference for the CircleCI 2.1 configuration keys used in theconfig.yml文件。存在.circleci / config.yml.file in your CircleCI-authorized repository branch indicates you want to use the 2.x infrastructure.

version

Key 必需的 类型 描述
version Y String 2,2.0, or2.1看看Reusing Configdoc概述了新的2.1键可用于简化您的.circleci / config.yml.file, reuse, and parameterized jobs.

version字段旨在用于发出警告以弃用或破坏变化。

绿色原子

Key 必需的 类型 描述
绿色原子 N 地图 A map of user-selected names to either: orb references (strings) or orb definitions (maps). Orb definitions must be the orb-relevant subset of 2.1 config. See the创作球体documentation for details.
执行者s N 地图 串的映射到执行者定义。看看执行者section below.
命令 N 地图 A map of command names to command definitions. See the命令section below.
version:2.1绿色原子:你好:circleci/hello-build@0.0.5工作流程:"HelloWorkflow":jobs:-你好/hello-build

在这个例子中,你好是considered the orbs reference; whereascircleci/hello-build@0.0.5是完全合格的ORB参考。

命令

命令定义定义了一系列步骤作为在作业中执行的映射,使您可以在多个作业中重复使用单个命令定义。

Key 必需的 类型 描述
脚步 Y 顺序 一系列步骤在命令的调用作业内运行。
参数 N 地图 A map of parameter keys. See the参数语法section of theReusing Config有关详细信息的文件。
描述 N String A string that describes the purpose of the command.
version:2.1命令:sayhello:描述:"Avery简单的命令fordemonstrationpurposes"参数:to:类型:细绳default:"HelloWorld"脚步:-:echo <<参数。至>>

参数

Pipeline parameters declared for use in the configuration. See管道变量使用详细信息。

Key 必需的 类型 描述
参数 N 地图 A map of parameter keys. Supports细绳,布尔基,整数and枚举类型。看参数语法for details.

执行者s

执行器定义将运行作业步骤的环境,允许您在多个作业中重复使用单个执行器定义。

Key 必需的 类型 描述
Docker. Y(1) List 选择Docker.执行者
resource_class. N String CPU和RAM在作业中分配给每个容器的RAM。Note:A paid account is required to access this feature. Customers on paid container-based plans can request access by开设支持票
机器 Y(1) 地图 选择机器执行者
苹果系统 Y(1) 地图 选择MacOS执行程序
视窗 Y(1) 地图 选择视窗执行者
shell N String Shell to use for execution command in all steps. Can be overridden byshellin each step (default: SeeDefault Shell Options)
working_directory N String 在哪个目录中运行步骤。
environment N 地图 环境变量名称和值的地图。

(1)应每个作业指定一个执行程序类型。如果设置了多个以上,您将收到错误。

version:2.1执行者s:my-executor:Docker.:-image:Circleci / Ruby:2.5.1-节点浏览器验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考jobs:my-job:执行者:my-executor脚步:-:echo outside the executor

看看在executors中使用参数section of theReusing Config文档,有关参数化执行器的示例。

jobs

运行由一个或多个命名作业组成。作业的名称是地图中的键,该值是描述作业的地图。

如果你是usingWorkflows,工作必须拥有唯一的名字.circleci / config.yml.文件。

如果你是不是使用工作流程,jobsmap must contain a job named建造。这建造job is the default entry-point for a run that is triggered by a push to your VCS provider. It is possible to then specify additional jobs and run them using the CircleCI API.

Note:作业的最大运行时间为5小时。如果您的工作是时机,请考虑同时运行其中一些工作流程

<job_name>

每个作业都是由作业名称作为键和地图作为一个值。一个名字应该在当前唯一jobs列表。值映射具有以下属性:

Key 必需的 类型 描述
Docker. Y(1) List 选择Docker.执行者
机器 Y(1) 地图 选择机器执行者
苹果系统 Y(1) 地图 选择MacOS执行程序
shell N String Shell to use for execution command in all steps. Can be overridden byshellin each step (default: SeeDefault Shell Options)
参数 N 地图 在执行此操作时,需要作为请求的一部分传递的参数映射
脚步 Y List 的列表脚步to be performed
working_directory N String 这directory used to run the steps. Default:〜/项目(在哪里项目是一个文字字符串,而不是您的特定项目的名称)。在作业期间运行的进程可以使用$ circle_working_directory.环境变量引用此目录。Note:Paths written in your YAML configuration file will不是扩大;如果你的store_test_results.。path$ circle_working_directory / tests, then CircleCI will attempt to store thetest目录的子目录字面称命名$ circle_working_directory., 美元符号$and all.
parallelism N 整数 运行此作业的并行实例数(默认值:1)
environment N 地图 环境变量名称和值的地图。
resource_class. N String CPU和RAM在作业中分配给每个容器的RAM。Note:A paid account is required to access this feature. Customers on paid container-based plans can request access by开设支持票

应每个作业指定一个执行程序类型。如果设置了多个,则会收到错误。

environment

环境变量名称和值的地图。这se will override any environment variables you set in the CircleCI application.

parallelism

如果parallelism设置为n> 1,然后将设置n个独立的执行器,每个都将并行运行该作业的步骤。这有助于优化您的测试步骤;您可以使用Circleci CLI跨越并联容器拆分测试套件,因此作业将在较短的时间内完成。某些并行感知步骤可以选择退出并行性,并且仅在单个执行程序上运行(例如deploy)。学习更多关于parallel jobs

注意working_directorywill be created automatically if it does not exist.

version:2.1jobs:建造:Docker.:-image:buildpack-deps:可靠验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考environment:FOO:barparallelism:3resource_class.:working_directory:〜/ my-app脚步:-:GO TEST -V $(GO列表。/ ... | CIRCLECI测试分裂)

Docker./机器/苹果系统/视窗(执行者)

An "executor" is roughly "a place where steps occur". CircleCI 2.0 can build the necessary environment by launching as many docker containers as needed at once, or it can use a full virtual machine. Learn more aboutdifferent executors

Docker.

由这组成配置Docker.key which takes a list of maps:

Key 必需的 类型 描述
image Y String 要使用的自定义Docker图像的名称
姓名 N String 容器可访问的名称。默认情况下,可以通过默认情况下访问容器服务localhost.
入口点 N 字符串或列表 启动容器时使用的命令用作可执行文件
命令 N 字符串或列表 启动容器时用作PID 1(或args for Entrypoint的命令)
用户 N String 哪个用户像Docker容器一样运行命令
environment N 地图 A map of environment variable names and values
验证 N 地图 使用标准的注册管理机构身份验证docker登录证书
aws_auth. N 地图 Authentication for AWS EC2 Container Registry (ECR)

首先imagelisted in the file defines the primary container image where all steps will run.

入口点从dockerfile覆盖默认的入口点。

命令将用作图像entrypoint的参数(如果在dockerfile中指定)或作为可执行文件(如果在此处或在dockerfile中提供了ententpoint)。

For主要容器(在名单中首先列出)如果没有命令那时是指定的命令and image entrypoint will be ignored, to avoid errors caused by the entrypoint executable consuming significant resources or exiting prematurely. At this time, all脚步仅在主容器中运行。

姓名字符串定义了到达辅助服务容器的名称。默认情况下,所有服务都直接曝光localhost.。这field is appropriate if you would rather have a different host name instead of localhost, for example, if you are starting multiple versions of the same service.

environmentsettings apply to all commands run in this executor, not just the initial命令。这environment在上面的作业地图中将其设置更高的优先级。

您可以使用标记或摘要指定图像版本。您可以使用任何公共Docker注册表(默认为Docker Hub)的任何公共图像。学习更多关于指定图像

Some registries, Docker Hub, for example, may rate limit anonymous docker pulls. It's recommended you authenticate in such cases to pull private and public images. The username and password can be specified in the验证场地。看Using Docker Authenticated Pullsfor details.

version:2.1jobs:建造:Docker.:-image:buildpack-deps:可靠# primary container验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考environment:ENV:CI-image:Mongo:2.6.8验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考命令:[-  amallfiles.]-image:Postgres:9.4.1.验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考environment:POSTGRES_USER:root-image:Redis @ SHA256:54057DD7E125CA41AFE526A877E8BD35EC2CDD33B9217E022ED37BDCF7D09673验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考-image:ACME-私人/私人镜头:321验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考

使用托管的图像AWS ECRrequires authentication using AWS credentials. By default, CircleCI uses the AWS credentials that you add to the Project > Settings > AWS Permissions page in the CircleCI application, or by setting theaws_access_key_id.andaws_secret_access_key.项目环境变量。也可以使用凭据来设置凭据aws_auth.场地。

version:2.1jobs:建造:Docker.:-image:AccountSid.dkr.ECR.US-EST-1.AMAZONAWS.com/org/repo:0.1.aws_auth.:aws_access_key_id.:Akiaqwerva.#可以指定字符串文字值aws_secret_access_key.:$ECR_AWS_SECRET_ACCESS_KEY# or project UI envar reference

可以重用宣布命令在使用版本2.1时在工作中。此示例调用sayhello命令。

version:2.1jobs:myjob:Docker.:-image:"Circleci / node:9.6.1“验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考脚步:-sayhello:to:"Lev"

机器

机器执行者通过使用来配置机器钥匙,拍摄地图:

Key 必需的 类型 描述
image Y String 要使用的VM图像。看法可用的图像Note:这key is不是支持可安装的circleci。有关定制的信息机器在服务器上安装Circleci上的执行程序图像,查看我们的VM服务文档
Docker._layer_caching N 布尔基 Set to真的启用Docker Layer CachingNote:您必须开设支持机票以进行Circleci销售代表,请与您联系您,以便在您的帐户中启用此功能以获得额外费用。
version:2.1jobs:建造:机器:image:Ubuntu-1604:201903-01脚步:-退房-:姓名:"测试“命令:回声“嗨”
可用的机器图片

CircleCI supports multiple machine images that can be specified in theimage场地:

这机器执行者supportsDocker Layer Caching当您在工作期间构建Docker图像或工作流程时,这很有用。

可用Linux GPU图像

When using theLinux GPU executor, the available images are:

可用的Windows GPU image

When using theWindows GPU executor, the available image is:

version:2.1工作流程:主要的:jobs:-建造jobs:建造:机器:image:Ubuntu-1604:201903-01Docker._layer_caching:真的#default  -  false

苹果系统

CircleCI supports running jobs on苹果系统,允许您构建,测试和部署麦斯科斯的应用程序,iOS,TVOS.andwatchOS。要在MacOS虚拟机中运行作业,必须添加苹果系统key to the top-level configuration for the job and specify the version of Xcode you would like to use.

Key 必需的 类型 描述
xcode Y String 这version of Xcode installed on the virtual machine. See the支持IOS的支持XCode版本部分文档为完整列表。

使用带Xcode版本11.3的MacOS虚拟机:

version:2.1jobs:建造:苹果系统:xcode:"11.3.0“

视窗

Circleci支持在Windows上运行作业。要在Windows计算机上运行作业,必须添加视窗作业的顶级配置的关键。ORB还可以轻松访问设置Windows作业。要了解有关运行Windows作业的先决条件以及Windows Machines可以提供的,请咨询Hello World on Windowsdocument.

使用Windows Executor运行简单的作业。

version:2.1绿色原子::circleci/windows@2.3.0jobs:建造:执行者:赢/默认脚步:-退房-:echo 'Hello, Windows'

分支机构

Defines rules for allowing/blocking execution of some branches if Workflows are不是configured and you are using 2.0 (not 2.1) config. If you are usingWorkflows,将忽略作业级分支,并且必须在您的工作流部分中配置config.yml文件。如果您使用的是2.1 Config,则需要添加工作流以便使用过滤。看看工作流程部分详情。工作级别branch钥匙拍摄地图:

Key 必需的 类型 描述
只要 N List List of branches that only will be executed
ignore N List 忽略的分支列表

两个都只要andignore列表可以具有全名和正则表达式。正则表达式必须匹配全部的细绳。

version:2.1jobs:建造:分支机构:只要:-master-/ rc-.*/

在这种情况下,只要"master" branch and branches matching regex "rc-.*" will be executed.

version:2.1jobs:建造:分支机构:ignore:-开发-/feature-.*/

在这个例子中,全部分支机构will be executed except "develop" and branches matching regex "feature-.*".

如果两者ignoreand只要are present in config, onlyignorewill be taken into account.

由于配置规则而未执行的作业将显示在UI中的作业列表中,但将被标记为跳过。

确保工作运行全部分支,要么不使用分支机构键,或使用只要与正则表达式一起:/.*抓住所有分支机构。

resource_class.

resource_class.功能允许为每个作业配置CPU和RAM资源。不同的资源类可用于不同的executors,如下表中所述。For self-hosted installations of CircleCI Server contact your system administrator for a list of available resource classes

Circleci为每个资源类实现软并发限制,以确保系统对所有客户保持稳定。如果您在某些资源类别进行了性能或自定义计划并体验队列,您可能会击中这些限制。联系Circleci支持to request a raise on these limits for your account.

Note:此功能可根据自由和性能计划自动启用。可用的资源类仅限于为Linux的Free / Medium提供的免费计划和介质的客户。宏尚未在自由计划上提供。如果您在集装箱计划中,您需要开票并与Circleci销售代表交谈,了解启用此功能。

Docker Executor
班级 vcpus. 内存
小的 1 2GB
媒介(默认) 2 4GB
中等+ 3 6GB.
4 8GB.
Xlarge. 8 16GB
2xlarge.(2) 16 32GB.
2xlarge.+(2) 20 40GB
version:2.1jobs:建造:Docker.:-image:buildpack-deps:可靠验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考resource_class.:Xlarge.脚步:... //其他配置
Machine Executor (Linux)
班级 vcpus. 内存
媒介(默认) 2 7.5GB.
4 15GB
Xlarge. 8 32GB.
2xlarge. 16 64 gb
version:2.1jobs:建造:机器:真的resource_class.:脚步:... //其他配置
苹果系统Executor
班级 vcpus. 内存
媒介(默认) 4 8GB.
(2) 8 16GB
version:2.1jobs:建造:苹果系统:xcode:"11.3.0“resource_class.:脚步:... //其他配置
Windows executor.
班级 vcpus. 内存
媒介(默认) 4 15GB
8 30GB.
Xlarge. 16 60GB.
2xlarge. 32 128GB.
version:2.1绿色原子::circleci/windows@2.3.0jobs:建造:执行者:赢/默认脚步:-:写主机'Hello,Windows'

看看Windows入门文档有关使用Windows Executor的更多详细信息和示例。

GPU Executor (Linux)
班级 vcpus. 内存 GPUS. GPU model GPU记忆(GIB)
gpu.nvidia.small.(2) 4 15 1 nvidia tesla p4 8
gpu.nvidia.medium.(2) 8 30 1 Nvidia Tesla T4 16
version:2.1jobs:建造:机器:resource_class.:gpu.nvidia.small.image:Ubuntu-1604-CUDA-10.1:201909-23脚步:-:nvidia-smi-:Docker Run  -  GPU所有NVIDIA / CUDA:9.0-基地NVIDIA-SMI

看看可用Linux GPU图像可用图像全部列表的部分。

GPU Executor (Windows)
班级 vcpus. 内存 GPUS. GPU model GPU记忆(GIB)
windows.gpu.nvidia.medium.(2) 8 30 1 Nvidia Tesla T4 16
version:2.1绿色原子::circleci/windows@2.3.0jobs:建造:执行者:赢/ gpu-nvidia脚步:-退房-:'&“c:\计划文件\ nvidia.Corporation\NVSMI\nvidia-smi.exe"'

这resource requires review by our support team.Open a support ticket如果you would like to request access.

Note:java,erlang和任何其他语言的内容/ proc.有关CPU计数的信息的目录可能需要其他配置以防止在使用Circleci 2.0资源类功能时减慢它们。具有此问题的程序可以请求32个CPU内核,并在请求一个核心时运行速度较慢。使用此问题的语言用户应将其CPU计数贴在其保证的CPU资源中。如果要确认您分配了多少内存,则可以检查CGROUP内存层次结构限制grep hierarchical_memory_limit /sys/fs/cgroup/memory/memory.stat

脚步

脚步setting in a job should be a list of single key/value pairs, the key of which indicates the step type. The value may be either a configuration map or a string (depending on what that type of step requires).

version:2.1jobs:建造:working_directory:〜/ canary-pythonenvironment:FOO:bar脚步:-:姓名:Running tests命令:制作测试

在这个例子中,是a step type. The姓名UI用于显示目的的属性。这命令属性是特定的步and defines command to execute.

Some steps may implement a shorthand semantic. For example,may be also be called like this:

version:2.1jobs:建造:脚步:-:制作测试

In its short form, the步骤允许我们直接指定哪个命令执行作为字符串值。在这种情况下,步骤本身为其他属性提供默认合适的值(姓名here will have the same value as命令, for example).

另一个步骤的另一个速记是为了简单地使用步骤作为字符串而不是键/值对:

version:2.1jobs:建造:脚步:-退房

在这种情况下,退房步骤将在作业中结帐项目源代码working_directory

In general all steps can be described as:

Key 必需的 类型 描述
Y 地图或字符串 A configuration map for the step or some string whose semantics are defined by the step.

Each built-in step is described in detail below.

用于调用所有命令行程序,采用配置值的映射,或者在其短窗格中调用时,将使用的字符串作为命令and姓名。默认情况下使用非登录shell执行运行命令,因此您必须将任何DotFiles源作为命令的一部分进行显式源。

Key 必需的 类型 描述
命令 Y String Command to run via the shell
姓名 N String 标题所示的步骤CircleCI UI (default: full命令)
shell N String Shell to use for execution command (default: SeeDefault Shell Options)
environment N 地图 Additional environmental variables, locally scoped to command
背景 N 布尔基 Whether or not this step should run in the background (default: false)
working_directory N String 运行此步骤的目录(默认值:working_directoryof the job)
no_output_timeout N String 经过时间,命令可以在没有输出的情况下运行。该字符串是单位后缀的十进制,例如“20m”,“1.25h”,“5s”(默认值:10分钟)
什么时候 N String Specify when to enable or disable the step。Takes the following values:总是,on_success.,On_Fail.(默认:on_success.)

Eachdeclaration represents a new shell. It's possible to specify a multi-line命令, each line of which will be run in the same shell:

version:2.1-:命令:|回声运行测试MKDIR -P / TMP /测试结果制作测试
默认shell选项

对于运行的工作Linux, the default value of theshell选项是/ bin / bash-eo pipefail如果/ bin / bash存在于构建容器中。否则是/ bin / sh -eo pipefail。默认shell不是登录shell(- 登录or-lare not specified). Hence, the shell will不是source your~/.bash_profile,~/.bash_login,~/.profilefiles.

对于运行的工作苹果系统, the default shell is/ bin / bash --login -eo pipefail。这shell is a non-interactive login shell. The shell will execute/etc/profile/其次是~/.bash_profile在每一步之前。

有关在调用Bash时执行的更多信息,see theINVOCATIONsection of the抨击合伙人

描述的描述-eo pipefailoptions are provided in the right pane.

-e

Exit immediately if a pipeline (which may consist of a single simple command), a subshell command enclosed in parentheses, or one of the commands executed as part of a command list enclosed by braces exits with a non-zero status.

所以,如果在前面的例子中mkdirfailed to create a directory and returned a non-zero status, then command execution would be terminated, and the whole step would be marked as failed. If you desire the opposite behaviour, you need to addset +ein your命令或覆盖默认值shell在您的配置地图中

version:2.1-:命令:|回声运行测试set +eMKDIR -P / TMP /测试结果制作测试-:shell:/bin/sh命令:|回声运行测试MKDIR -P / TMP /测试结果制作测试

-o pipefail

如果启用了pipefail,则管道的返回状态是退出的最后一个(最右侧)命令的值,或者如果所有命令都退出,则归零。shell等待管道中的所有命令在返回值之前终止。

version:2.1-:制作测试|TEE TEST-Output.log

如果制作测试fails, the-o pipefail选项将导致整个步骤失败。没有-o pipefail,该步骤将始终成功运行,因为整个流水线的结果由最后一个命令确定(TEE TEST-Output.log), which will always return a zero status.

请注意,即使制作测试fails the rest of pipeline will be executed.

如果you want to avoid this behaviour, you can specifyset +o pipefail在命令或覆盖整个shell(见上面的例子)。

通常,我们建议使用默认选项(-eo pipefail)因为它们在中间命令中显示错误并简化调试作业故障。为方便起见,UI将显示每个shell和每个的所有活动选项步。

For more information, see the使用shell脚本document.

Background commands

背景属性使您可以配置要在后台运行的命令。作业执行将立即进入下一步,而不是等待返回命令背景attribute set to真的。这example shows the config for running the X virtual framebuffer in the background which is commonly required to run Selenium tests:

version:2.1-:姓名:Running X virtual framebuffer命令:XVFB:99 -Screen 0 1280x1024x24背景:真的-:制作测试
速记语法

has a very convenient shorthand syntax:

version:2.1-:制作测试#缺口命令也可以有多行-:|MKDIR -P / TMP /测试结果制作测试

在这种情况下,命令and姓名成为字符串值,以及其余配置的图表有它们的默认值。

什么时候Attribute

By default, CircleCI will execute job steps one at a time, in the order that they are defined inconfig.yml,直到步骤失败(返回非零退出代码)。命令失败后,将不会执行进一步的作业步骤。

加入什么时候attribute to a job step allows you to override this default behaviour, and selectively run or skip steps depending on the status of the job.

默认值on_success.意味着只有在所有先前步骤都成功的(返回的退出代码0)时,才会运行该步骤。

A value of总是意味着,无论前一步骤的退出状态如何,都会运行该步骤。如果您有任何要运行的任务,这是有用的,无论上一步是否成功。例如,您可能有一个工作步骤,需要在某处上传日志或代码覆盖数据。

A value ofOn_Fail.means that the step will run only if one of the preceding steps has failed (returns a non-zero exit code). It is common to useOn_Fail.如果要存储一些诊断数据以帮助调试测试失败,或者运行有关故障的自定义通知,例如在聊天室中发送电子邮件或触发警报。

Note: Some steps, such asStore_Arifacts.andstore_test_results.will always run, even if a step has failed previously.

version:2.1-:姓名:Upload CodeCov.io Data命令:抨击<(curl -s https://codecov.io/bash) -F unittests什么时候:总是# Uploads code coverage results, pass or fail
什么时候(requires version: 2.1)

条件步骤由键的步骤组成什么时候orunless。在下面什么时候键是子键健康)状况and脚步。的目的是什么时候步骤是自定义命令和作业配置以在工作流程运行之前检查的自定义条件(以配置编译时间确定)。看看Conditional Steps section of the Reusing Config document更多细节。

Key 必需的 类型 描述
健康)状况 Y String A parameter value
脚步 Y 顺序 当条件为true时执行的步骤列表
version:2.1jobs:# conditional steps may also be defined in `commands:`Job_with_optional_custom_checkout.:参数:custom_checkout.:类型:细绳default:""机器:真的脚步:-什么时候:健康)状况:<< presides.custom_checkout >>脚步:-:echo "my custom checkout"-unless:健康)状况:<< presides.custom_checkout >>脚步:-退房工作流程:构建 - 测试部署:jobs:-Job_with_optional_custom_checkout.:custom_checkout.:"any非空的细绳判然“-Job_with_optional_custom_checkout.
Using管道。价值

管道值可用于所有的管道configurations and can be used without previous declaration. The pipeline values available are as follows:

价值 描述
管道 代表管道的全球唯一ID
管道。number Pipelin的项目独特整数ID
pipeline.project.git_url. 例如。https://github.com/circleci/circleci-docs.
管道。项目。类型 例如。"github"
pipeline.git.tag. 这tag triggering the pipeline
pipeline.git.branch.branch.branch 分支触发管道
pipeline.git.revision. 目前的Git修订
pipeline.git.base_revision. 以前的git修订
version:2.1jobs:建造:Docker.:-image:circleci / node:最新验证:用户姓名:mydockerhub-userpassword:$ dockerhub_password.#上下文/项目UI ENV-VAR参考environment:Imagetag.:latestworking_directory:〜/主要脚步:-:echo "This is pipeline ID << pipeline.id >>"
Using什么时候在工作流程中

With CircleCI configuration v2.1, you may use a什么时候条款(逆子句unless在工作流程声明下也支持了一个真实的或伪造值,以确定是否运行该工作流程。最常见的用途什么时候使用Circleci API V2管道触发参数。

这example configuration uses a pipeline parameter,run_integration_tests.to drive theIntegration_Tests.工作流程。

version:2.1参数:run_integration_tests.:类型:布尔基default:falsejobs:。。。

此示例可防止工作流程Integration_Tests.from running unless the tests are invoked explicitly when the pipeline is triggered with the following in thePOST身体:

version:2.1{"参数":{"run_integration_tests.":真的}}