From 53826eb4cf29ce2426f681bae716dec4a983da76 Mon Sep 17 00:00:00 2001 From: Elijah Duffy Date: Tue, 27 Oct 2026 23:01:41 -0700 Subject: [PATCH] docs(migrate): flag Go template incompatibility and CLI follow-up --- migrate/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/migrate/README.md b/migrate/README.md index 69a1f61..f76e5e0 100644 --- a/migrate/README.md +++ b/migrate/README.md @@ -5,7 +5,7 @@ It returns `*goose.Provider` directly: Goose owns execution, version tracking, status, and errors. There is no lifecycle dependency or background work. -Consumers must create migration files with Goose's +Create SQL migration files with Goose's [`create` command](https://pressly.github.io/goose/documentation/cli-commands/#create). For timestamp-to-sequential reconciliation before deployment, use its [`fix` command](https://pressly.github.io/goose/documentation/cli-commands/#fix) @@ -13,6 +13,14 @@ as described in [hybrid versioning](https://github.com/pressly/goose#hybrid-vers These commands edit source files before embedding; `fix` does not update database history. Never renumber migrations already applied to shared databases. +**Goose's default Go template is not compatible unchanged with this package.** +It registers migrations globally from `init`, while this package uses explicit +provider-local registration. Until the compatible authoring CLI planned in +[#9](https://gitea.auvem.com/corestack/go/issues/9) is available, Go migrations +require the adaptation described below; do not treat stock `goose create ... go` +output as ready to use. That follow-up must supply and document the supported +creation/reconciliation workflow before it is complete. + Embed migrations in the application's binary and run them before serving traffic: ```go