Schema Releases

[ralfhandl]

Currently the publication of new schema iterations happens quietly and often goes unnoticed.

We could announce new schema iterations more prominently by making them releases, for example with release names X.Y Schemas YYYY-MM-DD and tags X.Y.schemas-YYYY-MM-DD, see https://github.com/ralfhandl/express-experiments/releases for an experiment.

The latest release, whether spec release or schema release, is labeled "Latest" and will appear in the right sidebar of the repo start page.

On the "Releases" page the releases are sorted by tag in a semantic-version fashion. This means with spec releases tagged X.Y.Z and schema release tags prefixed with X.Y.schemas-, the spec releases will be on top in reverse order, then after the X.Y.0 spec the schema releases in reverse order, then the pattern repeats for the preceding MAJOR.MINOR spec and schema releases.

The schema publishing workflow could automatically create a draft schema release corresponding to the schema publishing PR. When the PR is merged, the draft release can be published.

What do you think?

[rmannibucau]

@ralfhandl think coupling that to github is not as nice as having json on a website (api like - could even get an openapi ;)) even if github pages cause then you depend on the api version and github lifecycle.

side note: I still fail to see how the smoother solution to just release the schema with any minor and the schema with a new minor if needed if an issue. It has two big advantages over your proposal: 1. it is straight forward for users (see previous discussions), 2. it is semver (the date is not and can't, the best you can do is to fake something comparable with X.Y.YYYYMMDD but far to be semver. So I'm still to make it fully automated and included in the spec and if any bug fix then rerelease the spec - it is literally as JavaEE/JakartaEE, the spec is the "doc" (markdown there) plus the API (code) plus the javadoc (doc of the code) so sounds very natural to do the same and make the spec moving to next level.

[ralfhandl]

Your lengthy side note belongs to #4233 and is off topic here.

Please remove it.

[rmannibucau]

Hmm, not that I do not want to remove it but I do not understand.

What do you think?

I do think this is a proposal which plays the status quo for the side note reason and I propose you to replace your proposal with the side note one so think it belongs to this ticket exactly.

What would be bad would be to enable to make your proposal and reopen an issue to say that it doesn't make the ecosystem better.

Hope it is clearer this way.