Open handrews opened 6 months ago
So... given the proposals for branching in PR #4154 (background in issue #3677), I can see a few options for schemas:
X.Y-dev
branches, but release independentlyThis would consolidate the schemas, based on the 3.1.1 files, under src/
(alongside the spec which is src/oas.md
) on the dev
branch, and we'd do the release-line-specific schema work on the appropriate X.Y-dev
branch.
Since schema releases are independent of patch releases, instead of making X.Y.Z-rel
branches to rename to the published file location, we'd make branches like 2024-10-22-rel
.
PROS:
CONS:
MITIGATION:
schemas/
layout but do the work on dev
PROS:
dev
and only merge them to main
when we want them publishedCONS:
git --format-patch | sed | git am -3
hackery stillMITIGATION:
/schemas
but work on X.Y-dev
In this approach, we don't rename any schema files into the src/
directory.
PROS:
CONS:
MITIGATIONS:
X.Y-dev
under src/
and release directly from thereThis approach more-or-less abandons schemas on dev
or main
, and just triggers publishing to the spec site directly from the X.Y-dev
branch.
PROS:
main
CONS:
main
?X.Y-dev
I'm splitting out the schema-related concerns from #3677 as we decided in a recent TDC meeting that the schema, spec, and gh-pages parts have different priorities (and probably involve different people).
schemas/
, just as #3677 recommends publishing the markdown to the currentversions/
location