Skip to content

feat(core): version configuration schema and define 1.0 migrations #1084

Description

@joshrotenberg

Problem

Profiles are persistent user data, but the TOML configuration currently has no explicit schema version or documented migration policy. A 1.0 support promise needs a safe path for evolving profiles, keyring references, defaults, and authentication metadata without silently breaking existing installations.

Work

  • Define and document a configuration schema version.
  • Preserve loading of supported legacy 0.x configurations, including Cloud, Enterprise, and direct database profiles.
  • Decide whether migrations are transparent, explicit, or both.
  • Make rewrites atomic and recoverable; do not lose unknown data or credentials silently.
  • Add representative legacy fixtures and round-trip/migration tests.
  • Define behavior for configurations produced by a newer redisctl version.
  • Document backup, recovery, and environment/keyring precedence.

Acceptance criteria

  • 0.11/0.12-era profile fixtures load successfully or produce a precise actionable migration error.
  • Any on-disk rewrite is atomic and has a documented recovery path.
  • Schema/version compatibility is covered by automated tests.
  • Future schema changes have an established migration mechanism and review checklist.

Parent: #1090.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestprofilesRelated to profile and credential managementrelease

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions