supabase / cli / 27410777621
65%

DEFAULT BRANCH: develop
Ran
Jobs 1
Files 225
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 64.858% (-0.04%) from 64.895%
27410777621

push

github

web-flow 
feat(cli): enable pg-delta by default for new projects (#5511)

First non-breaking step of CLI-1586 toward making pg-delta the default
diff engine. New projects opt into pg-delta, and `db pull` now lets the
configured engine drive its shadow diff. Existing projects are
unaffected.

## New projects default to pg-delta (CLI-1587)

`supabase init` now scaffolds `config.toml` with `[experimental.pgdelta]
enabled = true`. The global default for an absent/undefined section
stays migra, so existing projects are untouched and `enabled = false`
remains a one-line rollback.

The Go config template doubles as the source of programmatic defaults
via `mergeDefaultValues` (it ejects the same template), so literally
enabling pg-delta in the template would have flipped the default for
**every** existing config. To keep this non-breaking, the `enabled`
value is templated from an init-only flag `PgDeltaInitEnabled`:

- `InitConfig` sets it from `InitParams.UsePgDelta`, which is opted in
only by the `supabase init` command and `bootstrap`. Other `InitConfig`
callers — including the `WriteConfig` test helper — leave it `false`, so
they keep producing migra-default configs.
- It is `false` when `Eject` feeds `mergeDefaultValues`, so configs
without the section keep resolving to migra.

Scoping the opt-in to the command (rather than unconditionally inside
`InitConfig`) keeps the generated default from leaking into the global
`utils.Config` during tests that scaffold a config, which would
otherwise change unrelated `db start` behavior.

The TS init template (`project-init.templates.ts`) writes `enabled =
true` directly and stays byte-aligned with the Go scaffold (enforced by
the existing parity test).

## `db pull` engine resolution

When pg-delta is enabled (config or `EXPERIMENTAL_PG_DELTA`), `supabase
db pull` keeps its **migration-file** workflow but defaults the shadow
diff engine to pg-delta instead of migra. Specifically:

- The migration-file workflow is preserved; ... (continued)

10688 of 16479 relevant lines covered (64.86%)

7.21 hits per line

Coverage Regressions

Lines Coverage ∆ File
63
50.68
 -1.49% cmd/db.go
Jobs
ID Job ID Ran Files Coverage
1 27410777621.1 225
64.86
 GitHub Action Run
Source Files on build 27410777621