docs: frontend branching and publishing ADRs - #815
Merged
arbrandes merged 2 commits intoAug 12, 2026
Conversation
arbrandes
force-pushed
the
arbrandes/frontend-release-strategy
branch
from
August 4, 2026 16:19
fbdbba5 to
3e61cc7
Compare
This was referenced Aug 4, 2026
sarina
reviewed
Aug 4, 2026
brian-smith-tcril
left a comment
brian-smith-tcril
left a comment
Contributor
There was a problem hiding this comment.
Overall this looks good, couple small comments.
arbrandes
force-pushed
the
arbrandes/frontend-release-strategy
branch
2 times, most recently
from
August 6, 2026 15:17
eb7974e to
829ba49
Compare
Adds ADR 0002 on frontend stable branches and ADR 0003 on how semantically-released repositories participate in an Open edX release. Co-Authored-By: Claude <noreply@anthropic.com>
arbrandes
force-pushed
the
arbrandes/frontend-release-strategy
branch
from
August 12, 2026 13:47
829ba49 to
3876aeb
Compare
arbrandes
changed the title
brian-smith-tcril
left a comment
brian-smith-tcril
left a comment
Contributor
There was a problem hiding this comment.
Overall this is looking great! Couple notes about sections that felt a little unclear, looking forward to hearing your thoughts!
arbrandes
force-pushed
the
arbrandes/frontend-release-strategy
branch
from
August 12, 2026 18:00
3876aeb to
0e95fb5
Compare
Covers how a conversion branch takes over as the main branch, that OEP-10 governs the repository's branches once it has, and the legacy-mfe branch where the micro-frontend it replaces continues to live. Co-Authored-By: Claude <noreply@anthropic.com>
arbrandes
force-pushed
the
arbrandes/frontend-release-strategy
branch
from
August 12, 2026 18:09
0e95fb5 to
638ea4c
Compare
brian-smith-tcril
approved these changes
Aug 12, 2026
This was referenced Aug 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
OEP-10 pins a repository into a release by cutting a
release/RELEASENAMEbranch and tagging it, which works for components 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.The first change is to OEP-10 itself, which now distinguishes components that a release pins by git reference from those it pins by published version. It says where the record of a pinned version lives, and that being pinned by version does not lower a component's obligations under levels of support. None of this is frontend-specific: Python libraries pinned in
edx-platform's requirements files work the same way.Three ADRs follow from that. Under OEP-10, ADR 0002 (moved here from frontend-base's ADR 0012) settles what branches a semantically-released frontend repository has, what each of them publishes, how changes travel between them, and how the
stablebranch moves onto a new major once the main branch is ready for one. ADR 0003 settles how such a repository takes part in an Open edX release, which is by published version rather than by a branch cut at release time.Under OEP-65, ADR 0004 settles how an app repository's
frontend-baseconversion branch takes over as its main branch, that the OEP-10 ADRs govern its branches from that point on, and where the micro-frontend it replaces continues to live.LLM usage notice
Built with assistance from Claude.
Closes openedx/public-engineering#564