Skip to content

docs: Add frontend branching strategy ADR#94

Open
arbrandes wants to merge 1 commit intoopenedx:mainfrom
arbrandes:frontend-branching-strategy-adr
Open

docs: Add frontend branching strategy ADR#94
arbrandes wants to merge 1 commit intoopenedx:mainfrom
arbrandes:frontend-branching-strategy-adr

Conversation

@arbrandes
Copy link
Contributor

@arbrandes arbrandes commented Jul 31, 2025

This ADR introduces the concept of "main is unstable" to frontend repositories, from whence alpha packages will be published semantically to NPM.

Parent issue: #96

@arbrandes arbrandes mentioned this pull request Aug 7, 2025
1 task
@arbrandes arbrandes force-pushed the main branch 3 times, most recently from a6124e6 to 7e13eb9 Compare February 11, 2026 22:58
@arbrandes arbrandes force-pushed the frontend-branching-strategy-adr branch 2 times, most recently from b9c5038 to bf84e2f Compare March 4, 2026 15:54
@arbrandes arbrandes linked an issue Mar 4, 2026 that may be closed by this pull request
1 task
-----------------------------------

A repository's main branch will be published semantically to NPM with on an
"alpha" prerelease tag, with a monotonically incremented version number. For
Copy link
Contributor Author

@arbrandes arbrandes Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not married to "alpha". It could be "main", or "next", or anything else, really (as long as every frontend app repo follows the same pattern, of course).

@arbrandes arbrandes force-pushed the frontend-branching-strategy-adr branch from bf84e2f to 3ea2cbb Compare March 5, 2026 13:34
@holaontiveros
Copy link
Contributor

So just to be sure I get this right @arbrandes

  • Main becomes not prod ready, and is discouraged to use it directly on prod
  • There will be branches for something specifcally "stable" (n.x) (1.x, 2.x)

Now, how or were are we going to track what's compatible with which edx-platform version?

@arbrandes
Copy link
Contributor Author

arbrandes commented Mar 19, 2026

@holaontiveros

  • Main becomes not prod ready, and is discouraged to use it directly on prod
  • There will be branches for something specifcally "stable" (n.x) (1.x, 2.x)

That's exactly what I'm proposing, yes. (In addition to publishing from main using a prerelease tag such as the one we have now.)

how or were are we going to track what's compatible with which edx-platform version?

Good question.

It begins with this ADR. Prior to each release we'll announce which versions of things will work with that release. So the announcement would be the source of truth.

One potential de facto source of truth could be frontend-template-site. Whatever is in its package.json is what that release expects. (We would be tagging frontend-template-site with release/verawood.1, etc.)

And obviously Tutor itself, while downstream, would be de facto documentation.

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.

Frontend branching strategy ADR

2 participants