主题
命令与脚本
命令对象
json
{
"name": "2. Maven 构建生产包",
"script": "set -e\nmvn -P prod clean package -DskipTests",
"sortOrder": 2,
"enabled": true,
"failStrategy": "abort",
"workdirOverride": "",
"timeoutSec": 0,
"shellOverride": ""
}| 字段 | 说明 |
|---|---|
name | 显示名;日志中作为步骤标题 |
script | 内联脚本;与 scriptFile 二选一(CLI JSON 定义中) |
sortOrder | 顺序;按升序执行 |
enabled | false 时跳过该命令 |
failStrategy | abort 默认失败即中止;continue 忽略失败继续 |
workdirOverride | 覆盖本命令工作目录 |
timeoutSec | 覆盖本命令超时(0 沿用项目整体) |
shellOverride | 覆盖本命令解释器 |
scriptFile 是 CLI 定义文件侧的便利字段:相对 JSON 文件所在目录解析(sh/01.sh 或 sh\01.sh 均可), 读入后内容内联为 script,CRLF 归一化为 LF 以适配远程 Shell。服务端存储的始终是内联脚本。
执行语义
- 依序执行;每条命令独立进程(组),退出码非 0 且
failStrategy=abort→ 运行 failed,后续命令跳过。 continue用于「允许失败的收尾步骤」(如通知、清理),不影响最终成功判定之外的步骤推进。- 平台不解析脚本内容:
set -e、管道失败、健康检查都由脚本自己负责。建议每条脚本以有效健康检查收尾。 - 取消运行时按进程树杀进程:Linux 进程组信号、Windows
taskkill /T /F,避免留下孤儿构建进程。
命令 ID 与选择性运行
每条命令有服务端生成的 id。每次 project update 都会重新生成全部命令 ID(命令列表整体替换)。
bash
deploy project get my-app # 读当前命令 ID
deploy run my-app --command-id 10 --command-id 11 -f因此自动化脚本里不要缓存命令 ID;选择性运行前必须重新 get。 对照:任务步骤 ID 是位置序号、update 后不变(步骤 ID 与选择性执行)。
脚本组织建议
把多步脚本拆成文件随部署定义一起管理(参考技能包 assets 的六步法):
text
my-app/
project.json
sh/
01-recon.sh # 只读勘察
02-build.sh # 构建
03-publish.sh # 发布产物与外部配置
04-systemd.sh # 写 unit 并重启
05-healthcheck.sh # 等待 HTTP 200
06-ops.sh # 运维检查(选择性运行常用)好处:脚本可 review、可 diff、可单独跑(--command-id);配置与密码留在服务端 Secret 或受限文件,不进 Git。 完整示例见 tio-boot-web-hello 案例。
日志中的命令边界
运行日志按命令分段输出标题与退出码;网页终端与 CLI 同源。 Secret 值在日志中自动遮蔽(替换为掩码),但脚本自己 echo 出来的其他敏感内容不在遮蔽范围——遮蔽只覆盖已配置的 Secret 值。