docs: add frontend release ADRs to OEP-10 - #815
Conversation
fbdbba5 to
3e61cc7
Compare
brian-smith-tcril
left a comment
brian-smith-tcril
left a comment
There was a problem hiding this comment.
Overall this looks good, couple small comments.
| patches from each maintenance line, but declines minors, which cannot be assumed | ||
| to work against that release's backend:: |
There was a problem hiding this comment.
Reading this without context would lead me to question, "Why can't we trust minor version bumps? Shouldn't a feature that requires a new backend capability land as a breaking change?"
I agree this makes sense for Verawood, but saying minor version bumps can't be assumed to work against a release backend feels like us "doing something wrong" and something we should (at least plan to) fix.
There was a problem hiding this comment.
Well, here it's less about trust and doing wrong things, and more about just avoiding the perfectly possible and reasonable situation where a minor bump adds a feature the current backend doesn't support. I'm inclined to leave it as-is.
There was a problem hiding this comment.
I'd prefer to have the justification be about not having new features suddenly appear in releases. That's a clear decision about what should be in a release (the features that existed at cut), and shows our pinning aligns with that decision.
There was a problem hiding this comment.
Ok, cool. Reworded.
3e61cc7 to
eb7974e
Compare
Adds ADR 0002 on frontend release branches and ADR 0003 on how semantically-released repositories participate in an Open edX release. Co-Authored-By: Claude <noreply@anthropic.com>
eb7974e to
829ba49
Compare
3 participants
Description
OEP-10 pins a repository into a release by cutting a
release/RELEASENAMEbranch and tagging it, which works for repositories that are deployed from, or built out of, a checkout of themselves. Under OEP-65 a frontend app is neither: it is published as an NPM package and composed into a Site at build time. A release branch in an app repository would be inert, since nothing deploys from it and nothing consumes it. Nothing in this repo currently says how such a repository participates in a release instead.This adds two ADRs under OEP-10. ADR 0002 (moved from frontend-base's ADR 0012 here) settles what branches a semantically-released frontend repository has, what each of them publishes, and how changes travel between them. ADR 0003 settles how such a repository takes part in an Open edX release.
LLM usage notice
Built with assistance from Claude.