Skip to content

Closes Issue #811: docs: clarify CDM versioning standards and add NEWS.md (#811) - #812

Closed
Aprameyaraya wants to merge 3 commits into
OHDSI:mainfrom
Aprameyaraya:fix-811-versioning-guidelines
Closed

Aprameyaraya wants to merge 3 commits into
OHDSI:mainfrom
Aprameyaraya:fix-811-versioning-guidelines

Conversation

@Aprameyaraya

Copy link
Copy Markdown

Description

This PR resolves #811 by providing explicit guidelines on how OMOP CDM versioning (x.y.z) is handled across major, minor, and patch releases, and updates the repository documentation and changelog.

Changes Made

  • Documentation (site/faq.qmd): Added an explicit section to the FAQ detailing allowed and disallowed schema changes for Major (x.0.0), Minor (x.y.0), and Patch (x.y.z) releases.
  • Changelog (NEWS.md): Updated the development section to track changes for this fix.
  • Package Version (DESCRIPTION): Bumped package version to development state (5.4.2.9000).

Summary of Versioning Rules Documented

  • Major (x.0.0): Breaking schema changes allowed (dropping/renaming tables/columns, data type changes). Requires ETL adjustments.
  • Minor (x.y.0): Backwards-compatible schema additions allowed (adding new tables or optional columns).
  • Patch (x.y.z): No schema changes allowed (no modifying tables or columns). Reserved for DDL syntax fixes, constraint fixes, documentation updates, and R tooling maintenance.

Fixes #811

Added clarification on OMOP CDM versioning guidelines.
Added section on OMOP CDM versioning and its release types.

@MaximMoinat MaximMoinat left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please visit an upcoming CDM WG to discuss.

@brianrepko

Copy link
Copy Markdown

I was looking in #811 for rules such as this - major version, minor version, and patch version restrictions on the schema.
In looking at differences, the description above does not seem to be true.
Please use the original issue to come up with a policy here, please.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarification on OMOP CDM versioning standards

3 participants