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

Changing from negative-id CommentAnnotations and MapAnnotations to XMLAnnotations for non-OME data model info #74

Merged
merged 25 commits into from
Jan 25, 2024

Conversation

erickmartins
Copy link
Collaborator

This PR deals with issue #66 - we encode non-OME data model information (such as server path for files and provenance metadata) in XMLAnnotations instead of ad-hoc CommentAnnotations and MapAnnotations.

This allows us to provide and enforce schemas for these info. Right now, no schema validation is being done, but that's in the plans.

(PR work is still in progress - tests are not passing)

@joshmoore
Copy link
Member

This makes me wonder what about existing workflows (such as those implemented during the recent hackathon) will break...

@erickmartins
Copy link
Collaborator Author

This makes me wonder what about existing workflows (such as those implemented during the recent hackathon) will break...

Anything that only uses the CLI interface should work as-is. But this will be a breaking change; packs generated with older versions will not be able to be unpacked with the new version.

@joshmoore
Copy link
Member

nods At the hackathon folks were certainly starting to look into the XML. Knowing that this is why bioformats2raw is called such ("it's a black box!"), this might be something to discuss in the new year.

@erickmartins
Copy link
Collaborator Author

(as an FYI to folks with open PRs (@glyg @joshmoore @jburel ): I will merge this one last, because it's a big enough change that will mean releasing 1.0 after it!)

@erickmartins erickmartins merged commit e8fc280 into ome:main Jan 25, 2024
1 check passed
@erickmartins erickmartins deleted the XMLAnnotations branch June 3, 2024 14:22
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.

None yet

2 participants