@cnbcool/cnb-api-generate 1.2.7 → 1.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cnbcool/cnb-api-generate",
3
- "version": "1.2.7",
3
+ "version": "1.2.8",
4
4
  "main": "./built/index.js",
5
5
  "module": "./src/index.ts",
6
6
  "types": "./src/index.ts",
@@ -9,26 +9,39 @@ description: CNB OpenAPI 交互能力,支持仓库、Issue、PR、流水线、
9
9
 
10
10
  ## 快捷命令(优先使用)
11
11
 
12
- 可用快捷命令:
13
- - `issues`: `get`, `list-comments`, `comment`, `close`, `open`, `list-labels`, `add-labels`, `list-assignees`, `add-assignees`, `upload-file`, `upload-image`
14
- - `pulls`: `get`, `list-files`, `list-commits`, `list-comments`, `comment`, `list-labels`, `add-labels`, `check-status`, `list-reviews`, `list-assignees`, `upload-file`, `upload-image`
12
+ issues 快捷命令:
13
+ - `<$CNB_CLI_CMD$> issues get` 获取 Issue 详情
14
+ - `<$CNB_CLI_CMD$> issues list-comments` 列出 Issue 评论
15
+ - `<$CNB_CLI_CMD$> issues comment --data '{"body":"内容"}'` — 发表 Issue 评论
16
+ - `<$CNB_CLI_CMD$> issues close` — 关闭 Issue
17
+ - `<$CNB_CLI_CMD$> issues open` — 打开 Issue
18
+ - `<$CNB_CLI_CMD$> issues list-labels` — 列出 Issue 标签
19
+ - `<$CNB_CLI_CMD$> issues add-labels --data '{"labels":["标签"]}'` — 添加 Issue 标签
20
+ - `<$CNB_CLI_CMD$> issues list-assignees` — 查看 Issue 处理人
21
+ - `<$CNB_CLI_CMD$> issues add-assignees --data '{"assignees":["用户名"]}'` — 添加 Issue 处理人
22
+ - `<$CNB_CLI_CMD$> issues upload-file --data '{"file":"本地文件路径"}'` — 上传文件到 Issue
23
+ - `<$CNB_CLI_CMD$> issues upload-image --data '{"file":"本地图片路径"}'` — 上传图片到 Issue
24
+
25
+ pulls 快捷命令:
26
+ - `<$CNB_CLI_CMD$> pulls get` — 获取 PR 详情
27
+ - `<$CNB_CLI_CMD$> pulls list-files` — 列出 PR 变更文件
28
+ - `<$CNB_CLI_CMD$> pulls list-commits` — 列出 PR 提交记录
29
+ - `<$CNB_CLI_CMD$> pulls list-comments` — 列出 PR 评论
30
+ - `<$CNB_CLI_CMD$> pulls comment --data '{"body":"内容"}'` — 发表 PR 评论
31
+ - `<$CNB_CLI_CMD$> pulls list-labels` — 列出 PR 标签
32
+ - `<$CNB_CLI_CMD$> pulls add-labels --data '{"labels":["标签"]}'` — 添加 PR 标签
33
+ - `<$CNB_CLI_CMD$> pulls check-status` — 查看 CI 状态
34
+ - `<$CNB_CLI_CMD$> pulls list-reviews` — 查看评审列表
35
+ - `<$CNB_CLI_CMD$> pulls list-assignees` — 查看 PR 处理人
36
+ - `<$CNB_CLI_CMD$> pulls add-assignees --data '{"assignees":["用户名"]}'` — 添加 PR 处理人
37
+ - `<$CNB_CLI_CMD$> pulls upload-file --data '{"file":"本地文件路径"}'` — 上传文件到 PR
38
+ - `<$CNB_CLI_CMD$> pulls upload-image --data '{"file":"本地图片路径"}'` — 上传图片到 PR
15
39
 
16
40
  注意:
17
- - **路径参数自动注入**:仓库 slug、Issue/PR 编号优先从环境变量自动获取,无需额外传入
41
+ - **路径参数自动注入**:仓库 slug、Issue/PR 编号优先从环境变量自动获取,无需额外传入任何其他参数
18
42
  - **默认只输出摘要**:会精简响应输出结果,只返回核心字段。加 `--verbose` 输出完整数据。
19
43
  - 快捷命令只能操作当前仓库的当前Issue或PR。跨仓库或跨编号操作请使用其他 API 命令。
20
44
 
21
- 用法: `<$CNB_CLI_CMD$> <module> <command>`
22
- - ✅ `<$CNB_CLI_CMD$> issues get`
23
- - ✅ `<$CNB_CLI_CMD$> pulls comment --data '{"body":"内容"}'`
24
-
25
- 需要 `--data` 的快捷命令:
26
- - `comment`: `--data '{"body":"内容"}'`
27
- - `add-labels`: `--data '{"labels":["标签"]}'`
28
- - `add-assignees`: `--data '{"assignees":["用户名"]}'`
29
- - `upload-file`: `--data '{"file":"本地文件路径"}'`(自动完成上传全流程)
30
- - `upload-image`: `--data '{"file":"本地图片路径"}'`(自动完成上传全流程)
31
-
32
45
  ## 其他 API(快捷命令不满足时使用)
33
46
 
34
47
  1. `<$CNB_CLI_CMD$> --help` 查看所有模块