Skip to content
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

Merged
merged 13 commits into from
Jan 27, 2025
Merged

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Jan 6, 2025

Resolves RCAL-977

This PR prepares RAD for versioning by:

  • updating docs to describe the versioning process
  • updating tests to allow for multiple manifests

See spacetelescope/roman_datamodels#445 for more details.

Tasks

  • Update or add relevant rad tests.
  • Update relevant docstrings and / or docs/ page.
  • Does this PR change any schema files?
    • Schema changes were discussed at RAD Review Board meeting.
  • Does this PR change any API used downstream? (If not, label with no-changelog-entry-needed.)
News fragment change types:
  • changes/<PR#>.feature.rst: new feature
  • changes/<PR#>.bugfix.rst: fixes an issue
  • changes/<PR#>.doc.rst: documentation change
  • changes/<PR#>.removal.rst: deprecation or removal of public API
  • changes/<PR#>.misc.rst: infrastructure or miscellaneous change

Copy link

codecov bot commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.59%. Comparing base (d96b8da) to head (9e6a4e6).
Report is 3 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@braingram braingram marked this pull request as ready for review January 6, 2025 19:02
@braingram braingram requested review from WilliamJamieson and a team as code owners January 6, 2025 19:02
docs/manifests.rst Outdated Show resolved Hide resolved
tests/test_manifest.py Outdated Show resolved Hide resolved
tests/test_schemas.py Outdated Show resolved Hide resolved
tests/test_schemas.py Outdated Show resolved Hide resolved
@schlafly
Copy link
Collaborator

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?

@braingram
Copy link
Collaborator Author

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 AsdfPackageVersionWarning warning when opening any file written with the 1.0.0 manifest, regenerating the reference files would silence the warning). From there we could march the versions forward until things are stable enough that we can claim 1.0.0 again. A slight modification to this approach would be to reversion everything to 0.0.1 knowing that we need to regenerate reference files and TVAC/FPS files.

@schlafly schlafly merged commit 31b143e into spacetelescope:main Jan 27, 2025
11 checks passed
@braingram braingram deleted the versioned branch January 27, 2025 14:27
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.

3 participants