docs: add ADR for app API compatibility manifest field - #307
Closed
arbrandes wants to merge 1 commit into
Closed
Conversation
Records the decision to assert app-to-frontend-base compatibility through an openedx.apiVersion manifest field validated by the CLI, rather than through npm peer dependency ranges, so that a single stale app no longer blocks every site from installing. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Author
|
#308 was closed as a non-issue. |
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
1 participant
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
Proposes moving the app-to-frontend-base compatibility assertion out of npm's peer dependency resolver and into an
openedx.apiVersionmanifest field that the CLI validates at build time. Today a single app whose peer range excludes the current frontend-base major makesnpm installfail for every site that includes it, because one version number governs both the site-facing surface and the API apps import.Under the proposal, apps loosen their peer range to a lower bound and declare the API version they target separately, so frontend-base can cut a major without waiting on the whole ecosystem to republish. The ADR also records what a frontend-base major means afterwards, and lists the alternatives considered, including a separate API package.
Relates to #308.
LLM usage notice
Built with assistance from Claude.