全部产品
Search
文档中心

云效:流水线步骤 steps

更新时间:Mar 25, 2025

流水线步骤(steps)是构成流水线任务的基本单元。每个流水线任务可以由一个或多个步骤组成,这些步骤按顺序执行,共同完成整个任务。每个步骤通常代表一个具体的动作或操作,例如编译代码、运行测试、构建镜像或部署应用。

示例

以下为一个 Java 构建的配置示例:

stages:
  build_stage:
    name: 构建阶段
    jobs:
      build_job: 
        name: 构建任务
        runsOn:
          group: public/ap-southeast-1
          container: build-steps-public-registry.ap-southeast-1.cr.aliyuncs.com/build-steps/alinux3:latest
        steps:
          setup_java_step:
            name: "安装Java环境"
            step: SetupJava
            with:
              jdkVersion: "1.8"
              mavenVersion: "3.5.2"
          command_step:
            name: "执行命令"
            step: Command
            with:
              run: |
                mvn -B clean package -Dmaven.test.skip=true -Dautoconfig.skip
          upload_artifact_step:
            name: "构建物上传"
            step: ArtifactUpload
            with:
              uploadType: flowPublic
              artifact: "Artifacts_${PIPELINE_ID}"
              filePath:
                - target/
                

详细说明

stages.<stage_id>.jobs.<job_id>.steps

流水线步骤,流水线任务可以由一个或多个步骤组成。

stages.<stage_id>.jobs.<job_id>.steps.<step_id>

必填。流水线步骤 id,唯一标识流水线步骤。step_id 只能包含字母、数字和 _ ,且必须以字母开头。长度限制 64 个字符。

stages.<stage_id>.jobs.<job_id>.steps.<step_id>.step

必填。选择具体使用步骤,具体查看配置 Flow 的 step 清单。示例:

jobs:
  build_job: 
    name: 构建任务
    runsOn:
      group: public/ap-southeast-1
      container: build-steps-public-registry.ap-southeast-1.cr.aliyuncs.com/build-steps/alinux3:latest
    steps:
      build_step:
        name: "执行命令"
        step: Command
        with:
          run: |
            mvn -B clean package -Dmaven.test.skip=true -Dautoconfig.skip
            

stages.<stage_id>.jobs.<job_id>.steps.<step_id>.name

如不填写,则使用step_id的值。流水线步骤的展示名称。长度限制 64 个字符。

stages.<stage_id>.jobs.<job_id>.steps.<step_id>.workspace

非必填。默认为用户指定的 defaultWorkspace。当用户指定 workspace 后,流水线步骤会默认进入该工作目录执行构建指令。示例:

sources:
  repo1:
    ……
  repo2:
    ……
defaultWorkspace: repo1
stages:
  build_stage:
    name: 构建阶段
    jobs:
      build_job: 
        name: 构建任务
        runsOn:
          group: public/ap-southeast-1
          container: build-steps-public-registry.ap-southeast-1.cr.aliyuncs.com/build-steps/alinux3:latest
        steps:
          build_step:
            name: "执行命令"
            step: Command
            workspace: repo2		#指定执行命令步骤执行工作目录为repo2
            with:
              run: |
                mvn -B clean package -Dmaven.test.skip=true -Dautoconfig.skip
                

stages.<stage_id>.jobs.<job_id>.steps.<step_id>.with

非必填。填写流水线步骤的参数,具体查看配置 Flow 的 step 详细说明。