-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: updated frontend-build & frontend-platform major versions #387
Conversation
@@ -58,7 +58,7 @@ | |||
"react-test-renderer": "17.0.2" | |||
}, | |||
"peerDependencies": { | |||
"@edx/frontend-platform": "^7.0.0", | |||
"@edx/frontend-platform": "^7.0.0 || ^8.0.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nit/sanity check] Will there be consuming MFEs still installing on frontend-platform v7 once these packages are upgraded in the consuming MFEs? If not, I'm wondering if frontend-platform v7 could be dropped in favor of only supporting v8 (though, doing so would require these packages to be released as a breaking change otherwise)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you touching on this. All MFEs will be moved to v8 once these packages are upgraded in the consuming MFEs. The initial proposal was indeed to transition all MFEs directly to frontend-platform
v8, which would have necessitated a major version release due to breaking changes, which was opposed & there was a strong recommendation to maintain compatibility with frontend-platform v7 in order to avoid breaking change releases for the few MFEs having consumers. ([1], [2], [3]).
@abdullahwaheed has been a strong advocate of avoiding major version releases in this context & can elaborate on how the decision to prevent major version releases in this case, by maintaining frontend-platform v7 as a peer dependency, outweighs the benefits that might come from moving exclusively to v8 for a case where all MFEs are to be moved to v8 eventually.
As we continue with the implementation, as detailed in all related PRs, all MFEs will indeed be moved to frontend-platform
v8 & frontend-build
v14 as part of this coordinated upgrade process.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@adamstankiewicz these new changes can work effectively with platform v7, so dropping its support and releasing a major change is not necessary. We will drop this support in future when we have some actual breaking change in this repo
Description
frontend-build
to v14 & Updatedfrontend-platform
to v8Reference to respective MFEs with the build and platform major version upgrades to be released as minor versions instead of major
Merge checklist:
frontend-app-learner-portal-enterprise
,frontend-app-admin-portal
, andfrontend-app-enterprise-public-catalog
). Will consumers safely be able to upgrade to this change without any breaking changes?BREAKING CHANGE
so the NPM package is released as such.Post merge:
chore(release): publish
) that incremented versions in relevant package.json and CHANGELOG files, and created Git tags for those versions.Publish from package.json
Github Action workflow to publish these new package versions to NPM.master
branch.npm view <package_name> versions --json
).