tech/sxchnge
1
0 Fork 0
Code Issues 6 Pull Requests 1 Actions Packages Projects 1 Releases Wiki Activity

docs: generate code from externally published schemas #78

Merged
tech merged 1 commits from codex/docs-external-schema into main 2026-11-02 15:09:55 +00:00
Conversation 0 Commits 1 Files Changed 1
+9 -6
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 5a0b211d5f - Show all commits
AGENTS.md
+9 -6
View File
@@ -13,14 +13,17 @@
- Never commit autogenerated code to the repository. This applies to backend, - Never commit autogenerated code to the repository. This applies to backend,
frontend, shared packages, and every other module, including generated frontend, shared packages, and every other module, including generated
protobuf bindings, API clients, serializers, and framework-generated code. protobuf bindings, API clients, serializers, and framework-generated code.
- Commit the schema source definitions, generator configuration, and reproducible - Use externally published schemas as generation inputs. Do not embed or commit
generation commands instead. Generate code from the schema source at build schema snapshots in the repository. Commit external schema references,
time, before any dependent validation or compilation steps, including in CI. generator configuration, and reproducible generation commands instead.
- Fetch the externally published schemas and generate code at build time, before
any dependent validation or compilation steps, including in CI.
- Keep generated outputs ignored by Git. Do not force-add ignored generated - Keep generated outputs ignored by Git. Do not force-add ignored generated
files or copy generated code into tracked source files. files or copy generated code into tracked source files.
- Change the source definitions or generator inputs rather than editing - Change schema sources in their owning project or update external schema
generated outputs. Document the generation workflow so a clean checkout can references and generator inputs rather than editing generated outputs.
build without committed generated code. Document the generation workflow so a clean checkout can build without
committed generated code or embedded schema snapshots.
## Local development tooling ## Local development tooling