Skip to content

Migration Guides

Each guide covers the breaking changes introduced in a specific release and provides before/after code examples with a clear migration path.

Available guides

From To Guide
v0.4 v0.5 Command composition redesign
v0.5 v0.6 Web-service components and shared TLS
v0.16 v0.17 Repo provider-aware auth
v0.16 v0.17 Hot-reload observer contract
v0.16 v0.17 Controls supervisor & lifecycle hardening
v0.16 v0.17 Browser allowlist is immutable
v0.17 v0.18 Opt-in ForcedUpdate policy
v0.19 v0.20 --wrap-subcommands removed
v0.19 v0.20 Deprecated setup middleware helpers removed
v0.21 v0.22 Containable.ConfigFiles() added
v0.24 v0.25 HCL/Terraform asset support removed
v0.25 v0.26 Deprecated gRPC config keys & update test seams removed
v0.27 v0.28 Signing & verification extracted to standalone modules
v0.x v0.x Typed config section adapters
v0.x v0.x Configuration moves to the go/config Store (Viper removed)
v0.x v0.x Chat settings constructors
v0.x v0.x Telemetry observability settings
v0.x v0.x Logger slog-first boundary
v0.x v0.x Telemetry value types moved to pkg/telemetrytypes
v0.x v0.x Annotation-based update-check exemption & auxiliary fast path
v0.x v0.x Server bind address & loopback metrics default
v0.x v0.x Props provider interfaces pruned; props.New constructor
v0.x v1.0 Migrating to v1.0
v0.x v0.x errorhandling.Fatal exits non-zero on usage/special errors
v0.x v0.x props.FeatureCmd renamed to props.FeatureID
v0.x v0.x Forge credential precedence moved into GTB
v0.x v0.x ReleaseSource.Params removed; provider settings move to configuration
v0.x v0.x Chat providers and forge adapters registered by the tool's main; gtb CLI moves to cli/
v0.x v0.x Props.Version and Props.Assets are concrete types
v0.x v0.x The forge backend implies the forge
v0.x v0.x Chat defaults in the manifest; the fallback chain is the module's
v0.x v0.x Author settings as one surface
v0.x v0.x Props.IO, and the setup wizards' test seams
v0.x v0.x Accessible prompts skip hidden pages, and running out of answers fails
v0.x v0.x features as a value, and a root that owns its registries
v0.x v0.x the scaffold's go.mod is edited in place
v0.x v0.x MCP publishes progressively, on the estate's own module
v0.x v0.x The mcp feature is a link, and a tool without it ships without go/mcp
v0.x v0.x The static release channel replaces the withdrawn direct channel
v0.x v0.x The config stack a tool declares is its precedence
v1.x v1.12 Secure credential storage
v1.x v1.x Context-aware credentials Backend

Writing a new guide

Use the _template.md file in this directory as a starting point:

  1. Copy it to docs/reference/migration/vX.Y-to-vX.Z.md.
  2. Replace all placeholder text.
  3. Group changes by package.
  4. Include before/after code blocks and a prose migration path for each change.
  5. Remove the template warning admonition at the top.