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.

Sign up for GitHub

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

Jump to bottom

Version required #186

Merged
merged 6 commits into from
May 23, 2023
Merged

Version required #186

merged 6 commits into from
May 23, 2023

Conversation

will-moore
Copy link
Member

Fixes #185.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 22, 2023 •
edited
Loading

Automated Review URLs

@will-moore will-moore mentioned this pull request Mar 22, 2023
Closed
@will-moore will-moore requested a review from sbesson April 12, 2023 15:14
sbesson
sbesson approved these changes Apr 17, 2023
View reviewed changes
Copy link
Member

@sbesson sbesson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Until a 1.0 version of the OME-NGFF specification is published, producers/consumers should definitely expect iterations of the spec containing breaking changes. Being able to unambiguously associate a dataset to a given version is critical both when writing and reading. In that sense, enforcing the version field feels like a very reasonable requirement at least from my side.

Assuming this gets included (is there a formal mechanism for accepting these types of changes), is there any reason to limit this change to the multiscales specification or are you also considering making the field mandatory in other locations?

@will-moore
Copy link
Member Author

I think that version should be mandatory for plate, but I'm not sure about image-label, well or omero metadata, since these will generally be under either multiscales or plate and I don't think we really have any examples of creating or handling different versions within the same file.

@will-moore
Copy link
Member Author

Added version requirement to plate. @sbesson OK with those changes? thx

sbesson
sbesson approved these changes Apr 18, 2023
View reviewed changes
Copy link
Member

@sbesson sbesson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No objections to requiring version in both plate and image from my side

@will-moore will-moore merged commit b7359aa into ome:main May 23, 2023
github-actions bot added a commit that referenced this pull request May 23, 2023
@will-moore @github-actions
chore(rebuild): Merge pull request #186 from will-moore/version_required
122ccde 
Version required

SHA: b7359aa
Reason: push, by @will-moore

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbesson sbesson sbesson approved these changes

@joshmoore joshmoore Awaiting requested review from joshmoore

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Change version field(s) from SHOULD to MUST
2 participants
@will-moore @sbesson