工作流任务

本文介绍如何在 Zadig 系统上集成工作流任务来源。工作流任务主要用于自定义工作流中，实现工作流的开放能力。

准备工作

第一步：编码实现自定义工作流任务，并将代码入库，目录结构组织如下：

  1. path/to/your/repo         # 代码库根目录
  2. ├── hello                 # 任务目录，每个任务在单独的目录中
  3. │   └── v0.0.1            # 版本号
  4. │       └── hello.yaml    # 对应该任务的 YAML 文件
  5. └── jira
  6.     └── v1.0.0
  7.         └── jira.yaml

以 Zadig 库中的 mysql-runner工作流任务 - 图1 (opens new window) 任务说明代码目录结构组织：

  1. mysql-runner                 # 任务目录，需要在代码库的根目录中
  2. └── v0.0.1                   # 版本号
  3.     ├── Dockerfile           # 对应 mysql-runner 的镜像构建 Dockerfile
  4.     ├── Makefile             # mysql-runner 的工程编译文件
  5.     ├── main.go              # mysql-runner 任务的实现源码
  6.     └── mysql-runner.yaml    # 任务的 YAML 配置文件

其中 mysql-runner.yaml 文件解读如下：

  1. name: "MySQL 数据库变更"                     # 任务名称
  2. version: "v0.0.1"                          # 任务版本
  3. description: "针对 MySQL 数据库执行 SQL 变量" # 任务描述
  4. image: koderover.tencentcloudcr.com/koderover-public/mysql-runner:v0.0.1-amd64 # 任务镜像
  6. inputs: # 参数配置，执行自定义工作流时可指定
  7.   - name: mysql_host
  8.     description: "mysql host"
  9.     type: string
  10.     default: ""
  11.   - name: mysql_port
  12.     description: "mysql port"
  13.     type: string
  14.     default: ""
  15.   - name: username
  16.     description: "mysql username"
  17.     type: string
  18.     default: ""
  19.   - name: password
  20.     description: "mysql password"
  21.     type: string
  22.     default: ""
  23.   - name: query
  24.     description: "query to be used"
  25.     type : text
  26.     default: ""
  28. envs: # 注入环境变量，任务执行时会读取该变量，具体实现请查看源码 main.go 文件
  29.   - name: MYSQL_HOST # 环境变量的名称
  30.     value: $(inputs.mysql_host) # 环境变量的值，形式为 $(inputs.key)
  31.   - name: MYSQL_PORT
  32.     value: $(inputs.mysql_port)
  33.   - name: USERNAME
  34.     value: $(inputs.username)
  35.   - name: PASSWORD
  36.     value: $(inputs.password)
  37.   - name: QUERY
  38.     value: $(inputs.query)

第二步：将上述代码库在 Zadig 中集成，可参考 代码源集成。

来源配置

系统管理员访问 系统设置 -> 集成管理 -> 工作流任务，配置代码仓库、分支等信息后保存。

若集成来源成功后，代码库中任务实现有改动，点击 同步 即可。

pipeline_task

使用

在自定义工作流中添加任务，选择任务即可，可修改任务中的变量配置。

pipeline_task pipeline_task