Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise semver patch version to include addition of new species #1160

Open
brianraymor opened this issue Dec 20, 2024 · 0 comments
Open

Revise semver patch version to include addition of new species #1160

brianraymor opened this issue Dec 20, 2024 · 0 comments
Assignees
Labels
5.3 Next minor CELLxGENE schema version after 5.2 editorial schema CELLxGENE Discover dataset schema

Comments

@brianraymor
Copy link
Contributor

Context

Supporting a new organism is additive to the schema. There should be zero impact on existing datasets in the corpus. Historically, updating the schema version requires that the data corpus is migrated to the new version. The recommendation is to use semver patch:

  • Patch version is incremented for editorial changes and when new organisms are added that do not require new schema fields such as strain.
  • The schema_version is limited to major.minor.0 or major.minor, not major.minor.patch.
  • The schema_reference is limited to major.minor.0/schema.md or major.minor/schema.md, not major.minor.patch/schema.md. The schema is updated in place but its internal version is updated to reflect the patch - Version: 5.2.1.
  • Or we allow the corpus to exist at different patch versions for major.minor.patch for such cases until the next major or minor schema update. This would require reviewing current code related to schema versions because patch has never been in use.
@brianraymor brianraymor added schema CELLxGENE Discover dataset schema editorial 5.3 Next minor CELLxGENE schema version after 5.2 labels Dec 20, 2024
@brianraymor brianraymor self-assigned this Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.3 Next minor CELLxGENE schema version after 5.2 editorial schema CELLxGENE Discover dataset schema
Projects
None yet
Development

No branches or pull requests

1 participant