-
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: support React 18 in @edx/frontend-enterprise-hotjar
#435
Conversation
@edx/frontend-enterprise-hotjar
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #435 +/- ##
==========================================
- Coverage 79.08% 78.99% -0.09%
==========================================
Files 35 37 +2
Lines 698 757 +59
Branches 179 191 +12
==========================================
+ Hits 552 598 +46
- Misses 133 146 +13
Partials 13 13 see 3 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
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.
Approved to unblock but curious if the versions of the updated packages should be pinned?
"@edx/browserslist-config": "^1.5.0", | ||
"@openedx/frontend-build": "^14.3.1", | ||
"react": "^18.3.1", | ||
"react-dom": "^18.3.1", | ||
"react-router-dom": "^6.29.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.
Should these packages be pinned?
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.
based on some recent conversations here, it's likely the convention of pinning NPM dependencies will change where we'll want to typically rely on ^
. Opting to proactively change it for this repo while we're here.
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.
This is good context on the newly minted convention that should work well with keeping our MFE packages up to date as well.
I share the same sentiment that package updates can be prefixed WITH ^..
, but would probably be worth sharing the information with other engineers since the pinned package version convention has been engrained in the orgs workflow.
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.
Definitely. Largely holding off on a broader inform until it gets into an org-wide ADR more formally; not sure if that's something Brian was planning to take on yet; if not, we could drive that forward, too.
Regardless, it'll actually make dev easier when installing/updating deps since NPM by default uses ^
; usually takes effort to remember to undo the ^
and re-run npm i
to pin it when doing something like npm i @openedx/paragon@22
.
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 new versions
) that incremented versions in relevant package.json and CHANGELOG files, and created Git tags for those versions is onmaster
(Important: ensure the Git tags are for the correct commit SHA).Publish from package.json
Github Action workflow to publish these new package versions to NPM.master
branch.npm view <package_name> versions --json
).