From 0bb3c41f863f52a07b97027d9e2a579ba937a693 Mon Sep 17 00:00:00 2001 From: Aprameyaraya <91876432+Aprameyaraya@users.noreply.github.com> Date: Mon, 21 Sep 2026 19:55:32 +0530 Subject: [PATCH 1/3] Update NEWS.md with versioning guidelines clarification Added clarification on OMOP CDM versioning guidelines. --- NEWS.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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 ====================== From 509a3d1a87a22a2afb02cb6ca3e24c3f19a61986 Mon Sep 17 00:00:00 2001 From: Aprameyaraya <91876432+Aprameyaraya@users.noreply.github.com> Date: Mon, 21 Sep 2026 19:56:00 +0530 Subject: [PATCH 2/3] Document OMOP CDM versioning scheme Added section on OMOP CDM versioning and its release types. --- site/faq.qmd | 10 ++++++++++ 1 file changed, 10 insertions(+) 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`. From 9a4abeb4b2291e0e86ae0471e478776af5116f1a Mon Sep 17 00:00:00 2001 From: Aprameyaraya <91876432+Aprameyaraya@users.noreply.github.com> Date: Mon, 21 Sep 2026 19:56:23 +0530 Subject: [PATCH 3/3] Update package version to 5.4.2.9000 --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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"),