Autogenerated Files CI Check
❔Advice✅Resolved🎁Feature Request
Has anyone a solution for ensuring all files within
Context:
I lead multiple teams of engineers, all using convex with self-hosted deployments and infrastructure. One problem we consistently face (especially with new hires/engineers) is our
Current Effort:
I tried my hand at writing a bash script to start
Desired Result:
I want to make sure my engineers cannot break convex deployments by failing to run
./convex/_generated./convex/_generated are up to date with Git-tracked code changes?Context:
I lead multiple teams of engineers, all using convex with self-hosted deployments and infrastructure. One problem we consistently face (especially with new hires/engineers) is our
./convex/_generated/**./convex/_generated/** files getting out-of-date. An engineer might create a new aggregate but forget to run npx convex devnpx convex dev (or a similar to command) to auto-generate the necessary convex backend files. This has started causing problems with our continuous deployments where our application fails to start because of missing imports/declarations. Current Effort:
I tried my hand at writing a bash script to start
npx convex devnpx convex dev as a background daemon, watching that process with nohup, and waiting for convex to be started successfully. If the ./convex/_generated/./convex/_generated/ folder has a Git diff before/after running the convex deployment, if any files are changed/modified, a non-zero exit code is raised. While this works with local development, I can't seem to get the script to work during headless runs in GitHub actions. Since the GitHub actions runner does not have any local deployment setup, an interactive prompt is raised which causes the check to ultimately fail. I scanned through the current npx convex dev implementation and have been unable to find a workaround solution. From what I can tell, file generation is ran as a subprocess. Desired Result:
I want to make sure my engineers cannot break convex deployments by failing to run
npx convex devnpx convex dev and leaving our auto-generated files out-of-sync. One idea is having flag options for --codegen--codegen and a new --check--check such that npx convex dev --codegen only --checknpx convex dev --codegen only --check limits the convex command to just validating auto-generated files and returning a non-zero exit code if files change.
