docs: Update spec with breaking change notice and error handling

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-03-18 13:22:37 +08:00
parent 9a5430bbb6
commit a05c8751cd

View File

@@ -58,7 +58,9 @@ zzpyjenkins -s work build my-job
| 场景 | 行为 | | 场景 | 行为 |
|------|------| |------|------|
| 未指定 `-s` | 显示错误信息,提示必须指定服务器名 |
| 配置文件不存在 | 显示错误信息,提示配置文件路径 | | 配置文件不存在 | 显示错误信息,提示配置文件路径 |
| TOML 语法错误 | 显示 Python 解析错误信息 |
| 服务器名不存在 | 显示错误信息,列出可用的服务器名 | | 服务器名不存在 | 显示错误信息,列出可用的服务器名 |
| 配置项缺失 (url/username/password) | 显示错误信息,指出缺失的字段 | | 配置项缺失 (url/username/password) | 显示错误信息,指出缺失的字段 |
@@ -89,6 +91,8 @@ zzpyjenkins -s work build my-job
## 迁移说明 ## 迁移说明
**注意:** 这是一个破坏性变更,环境变量和 CLI 参数方式将不再支持。
用户需要: 用户需要:
1. 创建配置文件 `~/.config/zzpyjenkins/config.toml` 1. 创建配置文件 `~/.config/zzpyjenkins/config.toml`
2. 将原有的环境变量或 CLI 参数迁移到配置文件 2. 将原有的环境变量或 CLI 参数迁移到配置文件