Fail CI when the generated JSON Schema is out of date
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 84/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- github-actions, typescript
- Domain
- ci-cd
Research direction
Read the “Prompt kit is up to date” job in .github/workflows/ci.yml and the schema command in packages/cli/src/commands/schema.ts. Run npm run schema to see which files it generates, then add a CI check that runs the command and fails on git diff --exit-code schema/, with a message explaining how to regenerate the schema. Done when CI passes on main and fails when schema.ts changes without updating the generated schema.
Written by the indexing model from the issue text.
Description
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)
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- Avg merge
- 28m
- Merged PRs (30d)
- 2
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from nullthrone/lexvm
-
area: web good first issue priority: low type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
nullthrone/lexvm#49 ·
-
area: engine good first issue priority: low type: feature
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
nullthrone/lexvm#27 ·
-
area: web priority: low type: research
Difficulty 5/5 Over a week Newbie friendliness 35/100
nullthrone/lexvm#63 ·
-
area: infra area: web priority: medium type: chore
Difficulty 5/5 Over a week Newbie friendliness 38/100
nullthrone/lexvm#62 ·
-
area: engine area: web priority: high type: chore
Difficulty 5/5 Over a week Newbie friendliness 25/100
nullthrone/lexvm#61 ·
All issues in nullthrone/lexvm
Similar issues
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
openclaw/openclaw#182077 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
aikido high security
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
dequelabs/axe-linter-action#161 ·
-
[Feature Request] Update the DimCode agent icon to the 45:32 brand markPossibly taken @eric8810 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
lyswhut/lx-music-desktop#3026 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
abhigyanpatwari/GitNexus#3704 ·
Maintainers usually reply within 1 day