Skip to content

feat!: upgrade to frontend-base 2.0 - #1034

Merged
arbrandes merged 2 commits into
openedx:mainfrom
arbrandes:arbrandes/issue-1033-frontend-base-2.0
Aug 29, 2026
Merged

feat!: upgrade to frontend-base 2.0#1034
arbrandes merged 2 commits into
openedx:mainfrom
arbrandes:arbrandes/issue-1033-frontend-base-2.0

Conversation

@arbrandes

@arbrandes arbrandes commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Description

Takes the @openedx/frontend-base peer dependency to ^2.0.0-alpha || 0.0.0-dev, part of openedx/frontend-base#299. The range stays generic rather than naming a specific alpha, since a template should not pin copies of itself to whichever prerelease happened to be current. Nothing else was required, as the issue predicted: the template imports nothing from react-intl, declares no TypeScript type members for the new semicolon rule to catch, and bundles no config for App.defaultConfig to hold. Two things came along anyway. The empty config on the test site's app entry goes, since after ADR 0017 config is the operator's field. And the lockfile takes @openedx/paragon to 23.23.0, the floor frontend-base 2.0 requires, without which npm ci fails the peer check.

The second commit is the part specific to this repository being a template. README-template-frontend-app.rst is what every new App Repository starts from, and its Configuration section spoke only of per-app config. It now explains how getAppConfig resolves bundled defaultConfig below commonAppConfig below config, and which field a shipped default belongs in.

Closes #1033

LLM usage notice

Built with assistance from Claude.

@codecov

codecov Bot commented Aug 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 27.27%. Comparing base (7cc13e5) to head (d6c75be).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1034   +/-   ##
=======================================
  Coverage   27.27%   27.27%           
=======================================
  Files           9        9           
  Lines          22       22           
  Branches        1        1           
=======================================
  Hits            6        6           
  Misses         16       16           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

arbrandes and others added 2 commits August 29, 2026 10:52
Take the peer dependency to the 2.0 prerelease line on the alpha dist-tag,
which is where this repository's own main publishes too.  The range stays
generic rather than naming a specific alpha, since a template should not pin
copies of itself to whichever prerelease happened to be current.

The app bundles no config, so App.defaultConfig has nothing to hold here.  Drop
the empty config from the test site's app entry as well: config is the
operator's field, and an empty one on an app with no operator config is the
wrong shape for a template to teach.

The lockfile also takes @openedx/paragon from 23.21.2 to 23.23.0, the floor
frontend-base 2.0 requires.

BREAKING CHANGE: requires @openedx/frontend-base ^2.0.0-alpha.

Closes openedx#1033

Co-Authored-By: Claude <[email protected]>
The Configuration section spoke only of per-app config, which after ADR 0017 is
the operator's field, not the app author's.  Every new App Repository starts
from this README, so it should say which field a bundled default belongs in,
and that config is what an operator gets to set.

Co-Authored-By: Claude <[email protected]>
@arbrandes
arbrandes force-pushed the arbrandes/issue-1033-frontend-base-2.0 branch from 87c8f1a to d6c75be Compare August 29, 2026 13:53
@arbrandes
arbrandes merged commit 3971678 into openedx:main Aug 29, 2026
6 checks passed
@arbrandes
arbrandes deleted the arbrandes/issue-1033-frontend-base-2.0 branch August 29, 2026 13:55
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.

Upgrade to frontend-base 2.0

1 participant