RunPipelineConfig_Serverless开发平台(Serverless Devs)-阿里云帮助中心

名称	类型	描述	示例值
	object	触发后运行流水线配置
yamlFilePath	string	触发流水线执行的 cicd.yaml 在仓库中的位置，适用于 DevOps 的场景。此配置拥有最高优先级，所有流水线执行相关的配置都需要在 cicd.yaml 文件中定义，其他流水线执行配置均不生效。如果 cicd.yaml 不存在，则在触发执行时会出错。	cd.yaml
yamlFileContent	string	触发流水线执行的 cicd.yaml 的内容。此配置拥有仅次于 yamlFilePath 的优先级。所有流水线执行相关的配置都需要在 cicd.yaml 文件中定义，流水线执行配置均不生效。	kind: Pipeline # 流水线执行名称，需要全局唯一。如果流水线模板存在，则不能成功提交流水线执行 # 推荐使用commitID与时间戳构造唯一的名称 name: "p-<% .git.shortCommitId %>-<% .currentTimestampMs %>" # 一些任意的描述信息 description: 'demo pipeline' # 添加任意的labels，用于查询过滤 # 应用中心会在提交时也会添加其他labels labels: myLabel: my-cicd-example spec: context: data: appName: <% .appName %> envName: <% .envName %> deployFile: s.yaml templateSpec: # 要执行的任务，默认所有任务会一同尝试执行 # 执行会满足runAfters引入的先后约束，任务必须在runAfters声明的任务执行完毕后才可以被执行 # 用户可以使用此特性，达到DAG描述的效果 tasks: # 构建前检查 - name: pre-check context: data: displayName: "前置检查" # 打开任务执行，默认是关闭的 enable: true # 同样可以在此处声明钉钉告警配置，修改告警模板 # dingdingNotification: # 同样可以在此处声明或修改RunnerConfig # runnerConfig: # 执行步骤。下述步骤将会采用开源项目serverless-cd提供的engine进行执行 steps: # 第一步，初始化s工具 - plugin: "@serverless-cd/s-setup" # 第二步，checkout代码 # 这里采用了plugin机制，运行serverless-cd社区的插件 # @serverless-cd/checkout是一个社区提供的插件，它会将代码checkout到默认路径 # 我们会陆续为社区提供更多的插件 - plugin: "@serverless-cd/checkout" # 执行s-plan，并打印输出内容 # 这里为了说明engine能力，将它拆分成了多个step执行 - run: s plan -t ${{ ctx.data.deployFile \|\| "s.yaml" }} - run: echo "s plan finished." # 任务模板。这里使用了内置的模板serverless-runner-task taskTemplate: serverless-runner-task # 执行顺序，当前任务执行依赖runAfters任务都执行成功 runAfters: [] # 构建并部署 - name: build-and-deploy context: data: # 打开任务执行，默认是关闭的 enable: true # 同样可以在此处声明钉钉告警配置，修改告警模板 # dingdingNotification: # 同样可以在此处声明或修改RunnerConfig # runnerConfig: # 执行步骤。下述步骤将会采用开源项目serverless-cd提供的engine进行执行 steps: # 每个Task都是独立运行的Serverless实例，需要再次初始化s工具 - plugin: "@serverless-cd/s-setup" # 同理，需要重新checkout - plugin: "@serverless-cd/checkout" # 执行s-deploy - plugin: "@serverless-cd/s-deploy" taskTemplate: serverless-runner-task # 执行顺序，当前任务执行依赖runAfters任务都执行成功 runAfters: # 在approval后执行 - name: pre-check
pipelineSpec	PipelineSpec	流水线执行的配置描述
variables	array	流水线环境变量，可以在流水线执行时引用
	Variable	变量

object

触发后运行流水线配置

yamlFilePath

string

触发流水线执行的 cicd.yaml 在仓库中的位置，适用于 DevOps 的场景。此配置拥有最高优先级，所有流水线执行相关的配置都需要在 cicd.yaml 文件中定义，其他流水线执行配置均不生效。如果 cicd.yaml 不存在，则在触发执行时会出错。

cd.yaml

yamlFileContent

string

触发流水线执行的 cicd.yaml 的内容。此配置拥有仅次于 yamlFilePath 的优先级。所有流水线执行相关的配置都需要在 cicd.yaml 文件中定义，流水线执行配置均不生效。

kind: Pipeline # 流水线执行名称，需要全局唯一。如果流水线模板存在，则不能成功提交流水线执行 # 推荐使用commitID与时间戳构造唯一的名称 name: "p-<% .git.shortCommitId %>-<% .currentTimestampMs %>" # 一些任意的描述信息 description: 'demo pipeline' # 添加任意的labels，用于查询过滤 # 应用中心会在提交时也会添加其他labels labels: myLabel: my-cicd-example spec: context: data: appName: <% .appName %> envName: <% .envName %> deployFile: s.yaml templateSpec: # 要执行的任务，默认所有任务会一同尝试执行 # 执行会满足runAfters引入的先后约束，任务必须在runAfters声明的任务执行完毕后才可以被执行 # 用户可以使用此特性，达到DAG描述的效果 tasks: # 构建前检查 - name: pre-check context: data: displayName: "前置检查" # 打开任务执行，默认是关闭的 enable: true # 同样可以在此处声明钉钉告警配置，修改告警模板 # dingdingNotification: # 同样可以在此处声明或修改RunnerConfig # runnerConfig: # 执行步骤。下述步骤将会采用开源项目serverless-cd提供的engine进行执行 steps: # 第一步，初始化s工具 - plugin: "@serverless-cd/s-setup" # 第二步，checkout代码 # 这里采用了plugin机制，运行serverless-cd社区的插件 # @serverless-cd/checkout是一个社区提供的插件，它会将代码checkout到默认路径 # 我们会陆续为社区提供更多的插件 - plugin: "@serverless-cd/checkout" # 执行s-plan，并打印输出内容 # 这里为了说明engine能力，将它拆分成了多个step执行 - run: s plan -t ${{ ctx.data.deployFile || "s.yaml" }} - run: echo "s plan finished." # 任务模板。这里使用了内置的模板serverless-runner-task taskTemplate: serverless-runner-task # 执行顺序，当前任务执行依赖runAfters任务都执行成功 runAfters: [] # 构建并部署 - name: build-and-deploy context: data: # 打开任务执行，默认是关闭的 enable: true # 同样可以在此处声明钉钉告警配置，修改告警模板 # dingdingNotification: # 同样可以在此处声明或修改RunnerConfig # runnerConfig: # 执行步骤。下述步骤将会采用开源项目serverless-cd提供的engine进行执行 steps: # 每个Task都是独立运行的Serverless实例，需要再次初始化s工具 - plugin: "@serverless-cd/s-setup" # 同理，需要重新checkout - plugin: "@serverless-cd/checkout" # 执行s-deploy - plugin: "@serverless-cd/s-deploy" taskTemplate: serverless-runner-task # 执行顺序，当前任务执行依赖runAfters任务都执行成功 runAfters: # 在approval后执行 - name: pre-check

pipelineSpec

PipelineSpec

流水线执行的配置描述

variables

array

流水线环境变量，可以在流水线执行时引用

Variable

变量