Skip to content

Relax DocStringExtensions version constraint to support DocumenterVitepress#42

Merged
DilumAluthge merged 6 commits intoJuliaHealth:masterfrom
kosuri-indu:update/package-version
Feb 4, 2026
Merged

Relax DocStringExtensions version constraint to support DocumenterVitepress#42
DilumAluthge merged 6 commits intoJuliaHealth:masterfrom
kosuri-indu:update/package-version

Conversation

@kosuri-indu
Copy link
Member

@kosuri-indu kosuri-indu commented Feb 3, 2026

Summary

This PR relaxes the version constraint on DocStringExtensions from:

DocStringExtensions = "0.8"
to
DocStringExtensions = "0.8, 0.9"

to restore compatibility with newer documentation tooling.

Context

As part of a NumFOCUS Small Development Grant focused on improving JuliaHealth documentation workflows, we are evaluating and testing DocumenterVitepress as a potential documentation backend and reference template for JuliaHealth packages.

During this process, we observed that when DocStringExtensions is constrained to 0.8 only, attempting to add or use DocumenterVitepress causes dependency resolution to downgrade it to an older 0.0.2 version, which lacks functionality required by current documentation tooling.

Why this change is needed

  • OMOPCommonDataModel is a core dependency for multiple OMOP-related JuliaHealth packages.
  • Because these packages depend on OMOPCommonDataModel, restrictive version bounds here propagate downstream and block documentation tooling across the OMOPCDM ecosystem.
  • Allowing DocStringExtensions 0.9 prevents unintended downgrades and unblocks documentation builds for all dependent packages.

What changed & testing

  • Relaxed the version constraint to allow DocStringExtensions 0.9.
  • Verified locally that:
    • Documentation builds succeed with DocumenterVitepress
    • Dependency resolution no longer downgrades DocStringExtensions
    • Existing functionality remains unaffected

Notes

  • This PR does not force a migration to DocumenterVitepress.
  • It simply relaxes a constraint to improve compatibility and avoid tooling conflicts.
  • The change is compatible with existing setups.

Happy to adjust or test further if needed.

@kosuri-indu kosuri-indu changed the title Relax cStringExtensions version constraint to support DocumenterVitepress Relax DocStringExtensions version constraint to support DocumenterVitepress Feb 3, 2026
@DilumAluthge
Copy link
Member

Looks like CI is unhappy.

@kosuri-indu
Copy link
Member Author

Hey @DilumAluthge, some changes I made in this PR for successful CI / coverage work:

  • Updated dependency compatibility (DataFrames - SortingAlgorithms) to support the newer working needed for Documenter
  • Fixed documentation build issues caused by recent DataFrames changes (updated examples.md and docs/make.jl to align with current versions)
  • Updated to latest version of statements for CI
  • Added a repo upload token and configured the Codecov workflow

At the moment, codecov uploads are still blocked because the repository appears to be deactivated on codecov. I do not see an option to activate it on my end (seems admin-only), so I wanted to check if you are able to enable it here: https://app.codecov.io/github/JuliaHealth/OMOPCommonDataModel.jl/config

Once it's activated, codecov/project and codecov/patch should start reporting normally on PRs.

Thanks!

@DilumAluthge
Copy link
Member

Alright, I've activated Codecov on this repo.

@DilumAluthge DilumAluthge reopened this Feb 4, 2026
@codecov
Copy link

codecov bot commented Feb 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (3f869a3) to head (72ac3de).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master       #42   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            6         4    -2     
  Lines          113       128   +15     
=========================================
+ Hits           113       128   +15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kosuri-indu
Copy link
Member Author

kosuri-indu commented Feb 4, 2026

Yes! Thanks a lot, it looks like all the tests are passing now!

@DilumAluthge DilumAluthge merged commit 01a8cda into JuliaHealth:master Feb 4, 2026
8 checks passed
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.

2 participants