Skip to content

Schema version tracking #26

@edsu7

Description

@edsu7

The following ticket describes the proposed versioning methodology for data schema.

Specifically the issue has these considerations

  • Changes will be tracked via major and minor changes with Major left of decimal and minor right of decimal
  • Lectern handles versioning via decimal

Purposed rules for versioning in lectern:

  • base schema will retain it's own versioning in float format
  • extension schema will retain its own versioning
  • When registering a custom schema, custom schema major version will match base major version
  • Custom schema major bump version will reset custom minor version to zero
  • Custom schema minor version will bump when a base minor, extension minor, extension major change occurs
  • If multiple minor changes coincide, a single custom minor bump will occur
  • If any changes coincide with base major change, a single custom major bump will occur
  • schema level fields in custom schema will track base and extension version
  • If a major or minor version occurs in an unused base entity, custom schema versioning will still follow accordingly

Purposed rules for versioning in song analyses:
TBA

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions