Skip to content

docs(post-v0.4): refresh stale .worktree-isolation.yaml / DB plugin references#19

Merged
ikeikeikeike merged 1 commit into
mainfrom
fix/post-v04-stale-strings
Jun 18, 2026
Merged

docs(post-v0.4): refresh stale .worktree-isolation.yaml / DB plugin references#19
ikeikeikeike merged 1 commit into
mainfrom
fix/post-v04-stale-strings

Conversation

@ikeikeikeike

Copy link
Copy Markdown
Member

Sweep follow-up to #17 + #18: user-visible / source-comment strings that
still read like v0.3.

Touched:

  • `internal/backend/detect.go` — pkg doc + error message
  • `internal/envwriter/envwriter.go` — pkg doc + `.env.local` footer
    (rendered into every worktree's `.env.local`, so every operator sees it)
  • `internal/gitwt/gitwt.go` — DetectBase doc comment
  • `README.md` — Roadmap v0.4 row + Status section
  • `tests/integration/e2e_mysql_test.go` — fixture bumped to v0.4
    canonical (`schema_version: 2` / `engines:` / `port_ranges:` /
    `initial_resources:` / `role: engine-provider` / `.bough.yaml` /
    `.bough-ports.json` / registry key `mysql.main`)

The v0.3 → v0.4 migrateLegacy() path stays covered by the existing
config_test.go unit tests (TestLoad_validExample + TestLoad_migrateLegacy_v03);
the e2e test now exercises the canonical v0.4 wiring end-to-end so a
future schema bump cannot regress it silently.

What was deliberately left alone

  • `CHANGELOG.md` historical entries
  • `docs/MIGRATION-v0.3-to-v0.4.md` (= the WHOLE point is the v0.3 surface)
  • Fallback impl + deprecation messages in `internal/config/`,
    `internal/cli/helpers.go`, `internal/registry/`
  • `internal/config/testdata/example.yaml` (= the legacy fixture that
    `TestLoad_validExample` feeds into the migration path)
  • Historical predecessor refs (`verify-worktree-isolation.sh` /
    Python helper) in source comments

Test plan

  • `go build ./...`
  • `go vet ./...`
  • `go test ./internal/... ./conformance/...`
  • `nix develop .#ci -c golangci-lint run ./...` clean
  • CI green

…eferences

Several user-visible and source-comment strings still read like v0.3 even
after the v0.4 rename:

  - internal/backend/detect.go         pkg doc + error message
  - internal/envwriter/envwriter.go    pkg doc + .env.local footer
                                       (rendered into every worktree's
                                       .env.local, so every operator sees it)
  - internal/gitwt/gitwt.go            DetectBase doc comment
  - README.md                          Roadmap v0.4 row + Status section
  - tests/integration/e2e_mysql_test.go  fixture bumped to v0.4 canonical
                                         (schema_version: 2 / engines: /
                                         port_ranges: / initial_resources: /
                                         role: engine-provider /
                                         .bough.yaml + .bough-ports.json /
                                         registry key mysql.main)

The v0.3 → v0.4 migrateLegacy() path stays covered by the existing
config_test.go unit tests (TestLoad_validExample + TestLoad_migrateLegacy_v03);
the e2e test now exercises the canonical v0.4 wiring end-to-end so a
future schema bump cannot regress it silently.

Intentional v0.3 mentions (CHANGELOG history, MIGRATION doc, fallback
impl in helpers.go / config.go / registry.go, deprecation messages, test
fixtures under testdata/) are left untouched — they describe the v0.3
fallback the v0.4.x line still honours.

go build ./... + go vet ./... + go test ./internal/... ./conformance/...
+ golangci-lint clean locally.
@ikeikeikeike
ikeikeikeike merged commit 7145e2e into main Jun 18, 2026
9 checks passed
ikeikeikeike added a commit that referenced this pull request Jun 19, 2026
Bundles the work shipped on main since v0.4.0:

  - cobra help text refresh (#18)
  - .env.local footer + backend error + doc-comment sweep (#19)
  - README/MIGRATION + plugins/db/CONTRACT.md drop + nix-default
    clarification (#20)
  - smoketool extraction + lifecycle.go/create.go phase split (bc05a88)
  - CI conformance matrix path fix (3f133c0)

No behaviour change; all docs / strings / refactor.
@ikeikeikeike
ikeikeikeike deleted the fix/post-v04-stale-strings branch June 28, 2026 12:40
ikeikeikeike added a commit that referenced this pull request Jul 4, 2026
fix: retrospective review fixes for merged PRs #9/#10/#11/#12/#18/#19/#20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant