项目 - 工作流 - 《Zadig v1.8.0 文档》

配置工作流
定时器
Git Webhook
- GUI 方式
- YAML 方式
IM 状态通知
运行工作流

本文主要介绍 Zadig 的工作流的配置和使用。

配置工作流

工作流支持多种策略组合，完成从构建->部署->测试->分发全流程的自动化编排，快速验证快速反馈，保证代码的质量。

基本信息

主要包含工作流名称、描述信息、所属项目信息

参数说明:

工作流名称：名称只支持字母大小写和数字，特殊字符只支持中划线。
选择项目：选择工作流所更新的项目名称。
描述：描述该工作流的详细信息，在工作留详情页展示。
并发运行 新：多名合作者先后触发该工作流更新不同的服务时，产生的多个任务将会并发执行以提升构建、部署、测试效率。
镜像版本回退 新：若开启，则工作流执行完毕后，被更新服务的镜像会回退到工作流任务执行前的版本。更多信息可阅读：工作流的镜像版本回退。

构建部署

为服务配置构建后，工作流通过构建部署模块提供更新环境的能力。

服务构建配置细节可参阅构建配置

字段说明：

服务：内容的格式为服务名/服务组件名，点击服务可跳转查看该服务的配置详情。
部署：内容的格式为服务名/服务组件名。
是否显示：用于设置在启动工作流任务时，是否在服务列表中显示该服务。上图例中设置 redis 服务为不显示后，运行工作流时效果如下：

交付物部署

提供通过构建产物直接更新服务的能力

提示

同一个工作流中交付物部署和构建部署为互斥功能，只能选择一个进行开启

测试

通过修改工作流的测试配置，来实现测试步骤，关于测试配置的创建和使用，请参阅测试管理

自动化测试

用户可以通过添加测试按钮从测试配置中选择要添加的测试项目进行测试。

分发

通过配置分发模块，用户可以对服务的构建产物进行分发操作，目前支持镜像仓库分发和存储空间分发

前提

镜像的分发支持需要管理员提前正确配置镜像仓库
存储空间的分发支持需要管理员提前正确配置对象存储

参数说明：

添加服务：要被执行分发的目标服务
镜像仓库：构建的镜像产物被分发的目标镜像仓库，可在系统设置的镜像仓库中查阅
对象存储：构建的文件产物（一般为压缩包）被分发的目标对象存储，可在系统设置的对象存储中查阅

定时器

通过配置定时器，可以实现周期性的运行工作流。

目前工作流支持的定时器方式主要有：

定时循环：在某个时间点定时执行某个工作流，例如每天 12:00 运行，每周一 10:00 运行
周期循环：周期性的执行某个任务，例如每 30 分钟执行一次工作流
Cron 表达式：使用标准的 Linux Cron 表达式灵活的配置定时器，例如：”45 4 1,10,22 * *“，每月 1、10、22 日 4:45 分执行工作流任务

定时循环

具体操作步骤：

点击添加按钮添加一项定时循环条目，分别选择周期时间以及时间点
设置工作流任务参数，执行时按设置的参数执行

间隔循环

具体操作步骤：

第 1 步：点击添加按钮添加一项间隔循环条目，分别选择间隔时间以及间隔时间单位
第 2 步：设置工作流参数，执行时按设置的参数执行

Cron 表达式

具体操作步骤：

第 1 步：点击添加按钮添加一项 Cron 表达式条目，填写 Cron 表达式
第 2 步：设置工作流参数，执行时按设置的参数执行

Git Webhook

目前 Webhook 触发器支持 GUI 和 YAML 两种方式：

GUI 方式：Webhook 触发工作流运行相关参数配置在工作流中。
YAML 方式：Webhook 触发工作流运行相关参数组织在代码库的 YAML 文件中，在工作流中填写 YAML 文件路径即可。

GUI 方式

新增触发器模块，打开 Webhook 开关。

点击添加配置

参数说明：

代码库：需要监听触发事件的代码仓库，代码源选择不同对应的触发事件也会不同。
目标分支：提交 pull request 时的 Base 分支。支持正则表达式配置，语法参见 Regexp Syntax (opens new window)。
部署环境：指定触发任务部署步骤更新的环境，可指定多个环境。
环境更新策略：部署步骤更新环境的策略，可选策略如下：
- 更新指定环境：部署环境参数中指定一个环境时可选，部署更新该环境。
- 动态选择空闲环境更新：在部署环境指定的环境中，动态选择一个相对空闲的环境，对其进行部署更新。
提示

环境的空闲标准由正在对其进行部署更新的工作流任务数量而定，Webhook 触发事件发生时，当前工作流任务比较少的环境即为相对空闲的环境。
- 设定指定环境为基准环境：[高级选项] 部署环境参数中指定一个环境，且代码库是 GitLab 代码源时可选。以该环境的服务版本为基础创建一个名为 pr-prID-随机字符串的环境，对该环境进行部署更新。
环境销毁策略：[高级选项] 环境更新策略为设定指定环境为基准环境时可选。在 Webhook 事件触发工作流执行完毕后，对上述 pr-prID-随机字符串环境的销毁策略，包括：每次保留，每次销毁，工作流成功后销毁。
部署服务: 指定触发任务构建部署的相应服务。
触发事件: push 事件（Merge 操作）时触发，pull_request 提交 pull request 时触发，change-merged 修改被 merge 之后触发。
触发策略: 如果你希望只构建最新的提交，则使用这个选项会自动取消队列中的任务。
文件目录: 通过设置文件和文件目录，可以实现对文件以及目录的监听，当文件或者目录发生变化时（新增、修改或者删除），触发工作流。也可以忽略对应的文件或者目录变更，不进行工作流的触发。

使用以下代码仓库文件结构为例：

├── reponame  # 仓库名称
  ├── Dockerfile 
  ├── Makefile
  ├── README.md   
  ├── src        
    ├── service1/
    ├── service2/
    └── service3/

触发场景	文件目录配置
所有文件更新	`/`
除 *.md 以外的其他文件更新	`/` `!.md`
除 service1 目录下的其他文件更新	`/` `!src/service1/`
service1 目录下所有文件更新	`src/service1/`
src 目录下（除 service1 目录下的文件）的文件更新	`src` `!src/service1/`

YAML 方式

目前仅 GitLab 代码仓库支持 YAML 方式的触发器配置。

新增触发器模块，打开 Webhook 开关并添加配置。

在弹框中，点击YAML 方式 ，添加 YAML 描述文件（YAML 文件需事先提交到代码仓库中）。

参数说明：

代码库：需要监听触发事件的代码仓库。
YAML 文件路径：YAML 文件在代码库中存放的路径，比如图中 YAML 文件在 go-micro 库中的路径为 ci/zadig-trigger.yaml。

触发器 YAML 描述文件语法：

# 定义触发的步骤
# YAML 文件中一级关键字 build、deploy、test 必须保留
stages:
  - build
  - deploy
  - test
# 构建参数
build:
  - name:  service_name # 服务名
    service_module: service_module_name # 服务组件名
    variables: # zadig 系统中需要先声明出来才能指定，否则这边配置也无效
      - name: k1
        value: v1
# 部署策略
deploy:
  strategy: single # single(更新指定环境)/dynamic(动态选择空闲环境)/base(更新基准环境，需配置 env_recycle_policy 和 base_env)
  envs_name:
    - dev
  # strategy 值为 base 时才需配置以下变量
  # env_recycle_policy: success # success(成功后销毁)/always(每次销毁)/never(每次保留)
  # base_env: dev
# 测试参数
test:
  - name: test_name
    repo:
      strategy: currentRepo # default(在 zadig 平台默认配置的代码仓库信息)/currentRepo(使用当前变动的代码信息)
    variables:
      - name: k1
        value: v1
# 触发条件规则
rules: 
  branchs: 
      - 'feature*' 
  events:
      - pull_request
      - push
  strategy:
    # 自动取消，如果您希望只构建最新的提交，则使用这个选项会自动取消队列中的任务
    auto_cancel: true    
  # 指定服务与代码目录的关系，必填
  match_folders: 
    match_folders_tree:
      - name: service1
        service_module: service1
        file_tree:
          - src/service1
          - ci
      - name: service2
        service_module: service2
        file_tree:
          - src/service2
          - ci
# 缓存配置
cache_set: 
    # 不使用 docker 缓存
    ignore_cache: false
    # 不使用工作空间缓存
    reset_cache: false