Skip to content

feat: serve schemas based on which tags exist on gh - #581

Open
jo-mueller wants to merge 6 commits into
ome:mainfrom
jo-mueller:schemas-from-ngff-spec
Open

feat: serve schemas based on which tags exist on gh#581
jo-mueller wants to merge 6 commits into
ome:mainfrom
jo-mueller:schemas-from-ngff-spec

Conversation

@jo-mueller

@jo-mueller jo-mueller commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

PR following #564 that solves the problem a bit more elegantly (I hope):

This PR changes the build process of the page so that the following happens on build:

  • All tags on ome/ngff-spec are automatically retrieved with git ls-remote --tags https://github.com/ome/ngff-spec
  • This gives a list of tagged versions on that repo (currently not listing 0.1 ... 0.5)
  • Copy all the schemas over here and serve them under the respective tag.

This way, we should be able to access the schemas of all past (we'd need to tag them) and present through the ngff page, including the dev versions. This also centralizes the tagging over at ngff-spec as a core mechanic to make schemas available through the ngff page.

cc @jni

@github-actions

Copy link
Copy Markdown
Contributor

Automated Review URLs

@jo-mueller jo-mueller changed the title feat: serve schemas directly from gh WIP: feat: serve schemas directly from gh Aug 14, 2026
@jo-mueller
jo-mueller marked this pull request as draft August 14, 2026 22:12
@jo-mueller

Copy link
Copy Markdown
Contributor Author

@lubianat do you have ideas how to make this nicer? I tried a few things with redirects, but maybe the RTD redirects supersede any redirects to outside pages (i.e. via an htaccess file) I am defining here, which is annoying.

To have the browser render the schemas as text instead of downloading the files instantly, we would need to rename the files into .json, I think.

@jo-mueller
jo-mueller marked this pull request as ready for review August 19, 2026 08:37
@jo-mueller jo-mueller changed the title WIP: feat: serve schemas directly from gh feat: serve schemas directly from gh Aug 19, 2026
@jo-mueller jo-mueller changed the title feat: serve schemas directly from gh feat: serve schemas based on which tags exist on gh Aug 19, 2026
@lubianat

Copy link
Copy Markdown
Contributor

@jo-mueller should we go ahead and add the .json for the next releases (per #462)?

I don't have a suggestion on how to make it nicer, though

@jo-mueller

jo-mueller commented Aug 20, 2026

Copy link
Copy Markdown
Contributor Author

We could serve them as both *.schema and *.json? For the time being, this could also happen here until we make the change at ngff-spec?

@lubianat

Copy link
Copy Markdown
Contributor

We could serve them as both *.schema and *.json? For the time being, this could also happen here until we make the change at ngff-spec?

I don't have a good perspective on the implications. I guess we can do it at least transitionally, while tools move towards .json or .schema.json

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.

2 participants