-
Notifications
You must be signed in to change notification settings - Fork 22
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.
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
RCAL-977 - Version datamodels #528
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #528 +/- ##
=======================================
Coverage 96.59% 96.59%
=======================================
Files 4 4
Lines 235 235
=======================================
Hits 227 227
Misses 8 8 ☔ View full report in Codecov by Sentry. |
9e6a4e6
to
f0e8cde
Compare
Brett and I talked a fair amount about wanting to merge this soon. I think we could put this in now. One possibility we discussed was changing the default version to 0.0.0 instead of the somewhat misleading 1.0.0. I think that would break all of our files (?), but would otherwise be a sensible change. Other thoughts there? I guess we're not required to make that decision now, though we should make it soon. Such a change could also affect the reference files, though those have been more stable than the science files. @nden , anything else we should think about before merging this? @braingram , anything else I'm missing that we talked about on ~Thursday? |
Thanks! Yeah changing the current version to 0.0.1 isn't addressed in this PR and could use some more discussion/consideration (more on that below). I did update the docs to include some developer focused descriptions of:
For switching the current version to 0.0.1 we might want to first consider which schemas we deem to be "stable". For example if the TVAC, FPS and reference files are stable we could leave those as 1.0.0 (which would allow those files to open). The other schemas (and associated tags) could be rolled back to 0.0.1 (breaking all files that use those tags). The manifest could be rolled back to 0.0.1 (which would cause an |
Resolves RCAL-977
This PR prepares RAD for versioning by:
See spacetelescope/roman_datamodels#445 for more details.
Tasks
rad
tests.docs/
page.no-changelog-entry-needed
.)changes/
:echo "changed something" > changes/<PR#>.<changetype>.rst
(see below for change types).romancal
regression test (https://github.com/spacetelescope/RegressionTests/actions/workflows/romancal.yml) with this branch installed ("git+https://github.com/<fork>/rad@<branch>"
).roman_datamodels
utilities and tests.News fragment change types:
changes/<PR#>.feature.rst
: new featurechanges/<PR#>.bugfix.rst
: fixes an issuechanges/<PR#>.doc.rst
: documentation changechanges/<PR#>.removal.rst
: deprecation or removal of public APIchanges/<PR#>.misc.rst
: infrastructure or miscellaneous change