Skip to content

Commit 1de0c0d

Browse files
committed
docs(knowledge): update command reference documentation and tests
- Revised command reference files to clarify schema versioning and CLI version querying. - Updated tests to ensure that temporary channel versions do not alter committed references. - Enhanced documentation to prevent manual edits and improve consistency across references.
1 parent eddb70b commit 1de0c0d

5 files changed

Lines changed: 22 additions & 3 deletions

File tree

‎docs/agents/skill-change.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ bailian-gen bailian-finetune bailian-managed-agent bailian-web-search
6363
- [ ] 跑 `pnpm run sync:skill-assets`(或 commit 走 pre-commit),提交生成的 `reference/` 与 version 同步结果
6464
- [ ] 高风险命令生成的 reference 必须包含 `Risk` / `Risk message` 和简短 Agent safety 提示;带 `--yes` 的示例必须标注只能在确认后执行,不要手改生成物
6565
- [ ] `bailian-knowledge/reference` 由 `generate-knowledge-reference.ts` 通过 runtime 的 `buildCommandSchema` 生成,与 `--introspect` 共用数据源;分别读取 bl / kscli 的真实入口 map,不用字符串替换推导产品路径。统一生成入口负责归属迁移与旧文件清理。改动后运行 `tools/generate-reference.test.ts`、`tools/generate-knowledge-reference.test.ts` 和 `tools/knowledge-reference-renderer.test.ts`。
66+
- [ ] 纳入 Git 的 reference 不写入包版本号:channel 发布会在生成前临时 bump 为带时间戳的 beta 版本,否则每次发布都会触发生成物差异。可保留 schema 协议版本,实际 CLI 版本通过 `--version` / `--introspect` 查询。
6667
- [ ] 默认模型若写在领域路由表(如 `bailian-gen`):与命令 default / [model-add-remove.md](model-add-remove.md) 一并核对
6768

6869
## 完成后自查

‎skills/bailian-knowledge/reference/knowledge.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# bl command reference
22

33
> Generated from the same schema as `--introspect`. Do not edit by hand.
4-
> Version: 2.0.1; schema: 1.
4+
> Schema version: 1.
5+
> Query the installed CLI version with `bl --version`.
56
67
Cross-flag constraints are validated at execution and are not exported by this schema.
78

‎skills/bailian-knowledge/reference/kscli.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# kscli command reference
22

33
> Generated from the same schema as `--introspect`. Do not edit by hand.
4-
> Version: 2.0.1; schema: 1.
4+
> Schema version: 1.
5+
> Query the installed CLI version with `kscli --version`.
56
67
Cross-flag constraints are validated at execution and are not exported by this schema.
78

‎tools/knowledge-reference-renderer.test.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,17 @@ test("rendering is deterministic and does not mutate schema", () => {
8282
expect(renderKnowledgeReference(input)).toBe(renderKnowledgeReference(input));
8383
expect(input).toEqual(snapshot);
8484
});
85+
test("temporary channel versions do not change committed references", () => {
86+
for (const bin of ["bl", "kscli"]) {
87+
const stable = schema(bin, bin === "bl" ? "knowledge init" : "init");
88+
const channel = { ...stable, version: "0.0.0-beta-abcdef0-202610120930" };
89+
for (const locale of ["en-US", "zh-CN"] as const) {
90+
expect(renderKnowledgeReference(channel, locale)).toBe(
91+
renderKnowledgeReference(stable, locale),
92+
);
93+
}
94+
}
95+
});
8596
test("index links both actual product references", () => {
8697
const output = renderKnowledgeReferenceIndex();
8798
expect(output).toContain("(knowledge.md)");

‎tools/knowledge-reference-renderer.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,12 @@ export function renderKnowledgeReference(schema: CommandSchema, locale: Locale =
3535
"> Generated from the same schema as `--introspect`. Do not edit by hand.",
3636
"> 与 `--introspect` 使用同一份 schema 自动生成,请勿手动修改。",
3737
),
38-
`> ${pick("Version", "版本")}: ${schema.version}; schema: ${schema.schema_version}.`,
38+
// Channel releases temporarily bump package versions before checking these tracked assets.
39+
`> ${pick("Schema version", "Schema 版本")}: ${schema.schema_version}.`,
40+
pick(
41+
`> Query the installed CLI version with \`${schema.bin} --version\`.`,
42+
`> 使用 \`${schema.bin} --version\` 查询已安装的 CLI 版本。`,
43+
),
3944
"",
4045
pick(
4146
"Cross-flag constraints are validated at execution and are not exported by this schema.",

0 commit comments

Comments
 (0)