Skip to content

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

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.

Sign up for GitHub

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

Open
Aprameyaraya wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0bb3c41
Update NEWS.md with versioning guidelines clarification
Aprameyaraya Sep 21, 2026
509a3d1
Document OMOP CDM versioning scheme
Aprameyaraya Sep 21, 2026
9a4abeb
Update package version to 5.4.2.9000
Aprameyaraya Sep 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"),
Expand Down
8 changes: 8 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
======================

Expand Down
10 changes: 10 additions & 0 deletions site/faq.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.