Fabrica Migrations

Fabrica migrations update existing project source files when generator behavior changes. Run migrations from the project root before regenerating with a newer Fabrica version.

Available Migrations

Migration	Command	What it does	When to run
YAML tags	fabrica migrate yaml-tags	Adds missing yaml struct tags matching existing json tags in resource type files.	Existing services created before resource templates emitted YAML tags.

YAML Tags

The YAML tags migration updates files under apis/<group>/<version>/*_types.go so YAML data can be unmarshaled into resource structs the same way JSON data can.

For a field like this:

Spec DeviceSpec `json:"spec" validate:"required"`

the migration writes:

Spec DeviceSpec `json:"spec" yaml:"spec" validate:"required"`

The migration:

• Uses apis.yaml to find API groups, versions, and resources.
• Adds yaml tags only when a field already has a json tag.
• Uses the same tag name and options as the json tag, including omitempty.
• Preserves existing yaml tags unchanged.
• Preserves other tags such as validate.
• Skips fields tagged json:"-".
• Formats changed files with gofmt.

How to Migrate

Preview the changes first:

fabrica migrate yaml-tags --dry-run

Apply the migration:

fabrica migrate yaml-tags

Regenerate Fabrica-managed code so generated request models, clients, and storage helpers pick up updated templates:

fabrica generate

For a project outside the current directory, pass --dir:

fabrica migrate yaml-tags --dir /path/to/service --dry-run
fabrica migrate yaml-tags --dir /path/to/service

Troubleshooting

If the migration reports a parse error, fix the Go syntax in the referenced *_types.go file and rerun the command. The migration intentionally refuses to rewrite files that cannot be parsed safely.

If the dry-run reports no changes, the resource files already have YAML tags, do not have JSON tags to mirror, or are not listed under the configured API groups and versions in apis.yaml.