diff --git a/DESCRIPTION b/DESCRIPTION index 1a5c4f52..c13aa3d1 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: CommonDataModel Type: Package Title: OMOP CDM DDL and Documentation Generator -Version: 1.0.1 +Version: 5.4.2.9000 Authors@R: person(given = "Clair", family = "Blacketer", role = c("aut", "cre"), diff --git a/NEWS.md b/NEWS.md index 7b693552..0785d695 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,11 @@ +CommonDataModel (development version) +====================== + +Documentation: + +1. Clarified OMOP CDM versioning guidelines for Major (`x.0.0`), Minor (`x.y.0`), and Patch (`x.y.z`) releases (#811). + + CommonDataModel v5.4.2 ====================== diff --git a/site/faq.qmd b/site/faq.qmd index 5d6697f5..b56b29ac 100644 --- a/site/faq.qmd +++ b/site/faq.qmd @@ -192,3 +192,13 @@ It is difficult to recommend what technical capabilities a site needs to set up - Recommend - Cloud-based infrastructure like multiple AWS Redshift clusters, for example: - ![](man/images/AWS_clusters.png) + +## How is OMOP CDM versioning handled? + +The OHDSI Common Data Model follows a modified Semantic Versioning scheme (`x.y.z`): + +* **Major Releases (`x.0.0`)**: Include breaking schema changes, such as dropping or renaming tables and columns, changing data types, or major architectural restructuring. These releases require ETL code modifications. +* **Minor Releases (`x.y.0`)**: Include backwards-compatible schema additions, such as introducing new optional tables (e.g., `EPISODE`) or adding nullable columns to existing tables. +* **Patch / Build Releases (`x.y.z`)**: Strictly **disallow structural database schema changes** (no adding, removing, or renaming tables or columns). Patch releases are reserved for SQL dialect DDL fixes, constraint/index syntax updates, Quarto documentation fixes, website updates, and R package tooling maintenance. + +Note: Site documentation pages align with minor versions (`x.y`), while patch updates (`x.y.z`) update repository release tags, DDL files, and `NEWS.md`.