Skip to main content

Formatting and linting

The check variant of each recipe is a mode argument, not a separate recipe:
Go linting runs for both operating systems so files built only on Linux, such as the supervisor’s guest code, are checked too. buf lint runs through just proto-lint.

Testing

just test runs go test ./... in every Go module with GOWORK=off. The tests are unit tests. They need no KVM, Docker, PostgreSQL or NATS, so they run the same on a Mac as in CI. To see a change work end to end, run the stack with just dev and invoke a function, as in the Quickstart. The UI’s checks run together:
It type-checks the app and the library, runs Biome, builds the standalone app and the @galaxy-io/alchemy-ui module, checks the package with publint, builds the fixture host against it, and fails if the committed route tree is out of date.

What CI runs

Changing protos

The protos in protos/ drive both the Go API and the UI’s types. After a change, regenerate both and commit the output:
just proto-check fails if api/ is out of date. The UI job in CI runs on any change under protos/, so a proto change without a fresh ui/src/gen/ shows up there. A new service also needs a proxy entry in ui/vite.config.ts.

Changing the database

Migrations live in datastore/postgres/migrations and run when the server starts. CI holds them to three rules:
  • They pass goose validate.
  • Versions are unique and contiguous from 00001.
  • A shipped migration is never modified, renamed or deleted. Add a new one.
After changing a migration or a query, run just sqlc and commit datastore/postgres/sqlcgen.

Pull request titles and releases

Pull requests squash-merge with the title as the commit message, so the title must follow Conventional Commits, such as feat(api): ..., fix(host): ... or chore(tests): .... A check on every pull request enforces the format. Release Please reads those commits on main and keeps a release pull request open for each component: Before 1.0, a breaking change bumps the minor version, not the major. Changes under examples/ do not release Alchemy. The runtime images are not part of a release: they publish whenever something under runtimes/ changes on main.