chore: validate queries using sqlc-vet in github actions #11163
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this does
This runs
sqlc vet
using our queries and schema for a given commit. The only sql lint rule we currently have is that a query can be prepared against our schema.This protects us from writing a migration that breaks an existing query, or writing a new query that will not execute.
We unit test almost all of our queries, so this failure will likely be caught in
test-go-pg
. However, the reported failure will correspond to some number of Go tests, and the output might not be straight forward.sqlc vet
will have clearer reporting and easier debugging.Example
Found a query that does not work: (https://github.com/coder/coder/actions/runs/7186260845/job/19574288356)