Fail CI when the generated JSON Schema is out of date
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 84/100
- Issue 类型
- 功能
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- github-actions, typescript
- 领域
- ci-cd
调研方向
阅读 .github/workflows/ci.yml 中的 “Prompt kit is up to date” 作业，以及 packages/cli/src/commands/schema.ts 中的 schema 命令。运行 npm run schema 查看它会生成哪些文件，然后添加一项 CI 检查来运行该命令，并在 git diff --exit-code schema/ 检测到更改时失败，同时显示一条说明如何重新生成 schema 的消息。完成标准是 CI 在 main 上通过，并且在 schema.ts 更改但未更新生成的 schema 时失败。
由索引模型根据 Issue 内容生成。
描述
Context
schema/lexvm-pack-1.schema.json is generated from the zod schema by npm run schema, and editors validate packs against it. Unlike prompts/ (CI job "Prompt kit is up to date"), nothing checks that it is current, so a schema change without regeneration ships a stale editor schema.
Scope
- A CI job modelled on the prompts job: run
npm run schema, then fail ongit diff --exit-code schema/with a message that says how to fix it.
Acceptance criteria
- CI fails on a commit that changes packages/engine/src/schema.ts without regenerating schema/ (shown in the pull request).
- CI passes on
main.
References
- .github/workflows/ci.yml
- schema/lexvm-pack-1.schema.json
- packages/cli/src/commands/schema.ts
- CONTRIBUTING.md (Changing the content pack format)
- 主要语言
- TypeScript
- 星标
- 0
- 派生
- 0
- 平均合并
- 28 分钟
- 30 天内合并 PR
- 2
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
nullthrone/lexvm 的其他 Issue
-
area: web good first issue priority: low type: bug
难度 2/5 1-3 小时 新手友好度 82/100
nullthrone/lexvm#49 ·
-
area: engine good first issue priority: low type: feature
难度 2/5 1-3 小时 新手友好度 86/100
nullthrone/lexvm#27 ·
-
area: web priority: low type: research
难度 5/5 一周以上 新手友好度 35/100
nullthrone/lexvm#63 ·
-
area: infra area: web priority: medium type: chore
难度 5/5 一周以上 新手友好度 38/100
nullthrone/lexvm#62 ·
-
area: engine area: web priority: high type: chore
难度 5/5 一周以上 新手友好度 25/100
nullthrone/lexvm#61 ·
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
awesome-dsh-plugin/awesome-dsh-plugin#9184 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
farion1231/cc-switch#8829 ·
维护者通常 1 天内回复
-
[core-client] Remove unused hand-maintained transport helpers after the definition-table cutover未关闭doc-audit enhancement
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100