Relax DocStringExtensions version constraint to support DocumenterVitepress#42
Conversation
|
Looks like CI is unhappy. |
|
Hey @DilumAluthge, some changes I made in this PR for successful CI / coverage work:
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! |
|
Alright, I've activated Codecov on this repo. |
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
|
Yes! Thanks a lot, it looks like all the tests are passing now! |
Summary
This PR relaxes the version constraint on
DocStringExtensionsfrom: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
DocumenterVitepressas a potential documentation backend and reference template for JuliaHealth packages.During this process, we observed that when
DocStringExtensionsis constrained to0.8only, attempting to add or useDocumenterVitepresscauses dependency resolution to downgrade it to an older0.0.2version, which lacks functionality required by current documentation tooling.Why this change is needed
OMOPCommonDataModelis a core dependency for multiple OMOP-related JuliaHealth packages.OMOPCommonDataModel, restrictive version bounds here propagate downstream and block documentation tooling across the OMOPCDM ecosystem.DocStringExtensions 0.9prevents unintended downgrades and unblocks documentation builds for all dependent packages.What changed & testing
DocStringExtensions 0.9.DocumenterVitepressDocStringExtensionsNotes
DocumenterVitepress.Happy to adjust or test further if needed.