Skip to content

No upgrade migration path documented for future Blocky schema changes #97

@robocopklaus

Description

@robocopklaus

Description

The config.yaml schema is tied to Blocky v0.28.2. Future Blocky versions may introduce breaking schema changes (e.g., deprecating upstreams.groups), but no migration strategy is documented.

File(s)

  • blocky/config.yaml
  • blocky/CHANGELOG.md

Evidence

Commit a417032 ("add script to update Blocky configuration version") suggests migration tooling exists but its current status is unclear. CHANGELOG.md references v2.0.0 and v3.0.0 breaking changes.

Recommendation

  1. Clarify versioning strategy: is config.yaml schema locked to v0.28.2, or will it evolve?
  2. Document the migration script and its usage
  3. Add automated schema compatibility tests for new Blocky versions

Risk if Ignored

Future Blocky upgrades may break existing user configurations without a clear migration path.


Found by: Critique Agent (blind spot) | Reviewed by: Critique Agent

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation & UXinfoNice to have improvement

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions