Skip to content

预演 preview ​

作用 ​

deploy task preview <key> 把步骤展开成一段完整脚本并显示工作目录,不执行、不产生运行记录。 用于在执行前审查:变量展开结果、破坏性命令(rm/覆盖/重启)、路径是否正确。

bash
deploy task preview hula-srs-config
deploy task preview clear-cache -e SCOPE=session    # 带触发变量展开

等价 API:POST /api/v1/tasks/{key}/preview(body 可带 env)。

为什么任务特别需要预演 ​

任务常含「改配置 / 清数据 / 重启服务」类破坏性步骤,且没有 Git 准备阶段兜底(不会先对齐代码再跑)。 预演是执行前唯一的全脚本视图:步骤内联存储后,网页编辑页也能看,但 CLI 侧 preview 给出的是展开后的最终形态。

审查清单 ​

  • 变量占位是否都解析(残留 ${...} 说明变量未定义)。
  • rm / sed -i / systemctl restart / docker compose up -d 的作用对象是否符合预期。
  • 备份语句是否存在(改配置前先 cp 备份)。
  • workdir 是否指向预期目录(默认 ${WORKSPACE_ROOT}/${TASK_KEY})。
  • 幂等性:重复跑一遍是否安全。

与 dry-run 的区别 ​

task previewmiddleware install --dry-run
对象任务步骤脚本中间件安装脚本
产生运行记录否是(有日志、可回放)
执行完全不执行执行但带 --dry-run 只预演
平台限制无任何平台可预演,实装仅 Linux

中间件预演详见 安装与参数配置。

规程建议 ​

破坏性任务的首次执行流程:task get 看步骤 → task preview 审脚本 → 授权后 task run -f → 核对终态与副作用。 团队内把「preview 输出贴进变更单」作为配置类变更的评审材料。