为了满足不同企业的个性化需求，充分发挥团队的创造性，持续交付开放了自定义步骤能力，支持团队成员将内部得心应手的工具封装成自定义步骤，提高业务交付效率。本文为您介绍如何创建自定义步骤。

背景信息

自定义步骤由一个 YAML 描述文件构成。YAML 文件中包含自定义步骤的基本信息、步骤入参、步骤出参、步骤的执行脚本 script 及步骤的镜像 image。运行自定义步骤时，流水线会基于当前 YAML 起一组 Pod，执行 script 任务。

本文使用的自定义步骤 YAML 文件示例如下，您可基于此模板快速改造适合本团队的自定义步骤。

step: v2-custom-step # 自定义步骤名称，必填项。支持英文大小写字母、数字和连字符（-），长度为 2~50 个字符，不允许重名。​
​
version: 1.0.0 # 自定义步骤版本，必填项。格式为 x.y.z，x、y、z 均为 0~100 的整数。​
​
displayName: custom-step-v2-demo # 自定义步骤的显示名称，必填项。长度为 2~50 个字符，不允许为空或重名。​
​
description: custom-step-v2-demo # 自定义步骤描述，非必填。长度不超过 200 个字符。​
​
category: Other # 分类，必填项。可选值：Build、Test、Deploy、Registry、Command、Other。​
​
image: example.cr.volces.com/[命名空间]/busybox:latest # 运行时镜像，必填项。私有镜像需要配置 imageCredential。​
​
imageCredential: # 拉取私有镜像的凭证信息，非必填。​
  # 镜像仓库地址，仅填写域名。​
  registry: example.cr.volces.com​
  # 镜像仓库用户名。​
  username: "[镜像仓库用户名]"​
  # 镜像仓库访问密码。支持永久密码和临时密码。​
  password: "[镜像仓库访问密码]"​
​
script: | # 运行脚本，必填项，不能为空。​
  # 获取 cmd 配置项中设置的命令并执行。​
  $(inputs.cmd)​
  # 获取 pipeline-env 配置项的值并输出。​
  export ENV=$(inputs.pipeline-env)​
  echo "ENV: $ENV"​
  # 输出流水线 ID。​
  echo "PIPELINE_ID: $(PIPELINE_ID)"​
  # 输出流水线执行时间。​
  echo "DATETIME: $(DATETIME)"​
​
inputs: # 定义步骤的输入信息，非必填。支持配置多条步骤入参。​
  - name: cmd​
    displayName: Execute a custom command​
    description: Execute a custom command​
    type: string​
    defaultValue: echo hello world​
    required: true​
    uiConfig:​
      type: CodeEditor​
  - name: pipeline-env​
    displayName: Variables​
    description: Variables​
    type: string​
    defaultValue: ""​
    required: true​
    uiConfig:​
      type: Input​
​
# outputs: # 定义步骤的输出信息，非必填。本示例不使用 outputs。​
#   - name: xxx​
#     displayName: xxx​
#     type: string​

前提条件

已准备好自定义步骤使用的 Docker 镜像。建议上传至镜像仓库。上传至镜像仓库相关操作可参见推送和拉取镜像。

使用限制

拥有 CPAdminAccess 权限的账号可创建自定义步骤。子用户可联系对应火山引擎账号授予该权限，具体操作请参考配置权限。

通过在 YAML 文件中配置镜像访问凭证 imageCredential，可实现自定义步骤使用私有镜像。如果您对镜像安全性有更高的要求，推荐使用以下方案。

操作步骤

登录持续交付控制台，在左侧导航栏选择模板市场 > 步骤模板。

在步骤模板页面，单击创建自定义步骤，弹出创建自定义步骤面板。

在左侧输入框，按照自定义步骤的 YAML 要求，编写步骤内容。

编写完成后，单击确定。

创建成功的自定义步骤将展示在对应分类下。

后续操作

自定义步骤创建成功后，团队成员便可在流水线中使用。具体操作可参见使用自定义步骤。