Skip to content
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

Merged
merged 2 commits into from
Feb 24, 2025

Conversation

adamstankiewicz
Copy link
Member

Merge checklist:

  • Evaluate how your changes will impact existing consumers (e.g., frontend-app-learner-portal-enterprise, frontend-app-admin-portal, and frontend-app-enterprise-public-catalog). Will consumers safely be able to upgrade to this change without any breaking changes?
  • Ensure your commit message follows the semantic-release conventional commit message format. If your changes include a breaking change, ensure your commit message is explicitly marked as a BREAKING CHANGE so the NPM package is released as such.
  • Once CI is passing, verify the package versions that Lerna will increment to in the Github Action CI workflow logs.
    • Note: This may be found in the "Preview Updated Versions (dry run)" step in the Github Action CI workflow logs.

Post merge:

  • Follow the release steps in the README documentation. Verify Lerna's release commit (e.g., chore(release): publish new versions) that incremented versions in relevant package.json and CHANGELOG files, and created Git tags for those versions is on master (Important: ensure the Git tags are for the correct commit SHA).
  • Run the Publish from package.json Github Action workflow to publish these new package versions to NPM.
    • This may be triggered by clicking the "Run workflow" option for the master branch.
  • Verify the new package versions were published to NPM (i.e., npm view <package_name> versions --json).
    • Note: There may be a slight delay between when the workflow finished and when NPM reports the package version as being published. If it doesn't appear right away in the above command, try again in a few minutes.

@adamstankiewicz adamstankiewicz changed the title feat: support React 18 feat: support React 18 in @edx/frontend-enterprise-hotjar Feb 24, 2025
Copy link

codecov bot commented Feb 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.99%. Comparing base (c317ac0) to head (2af4049).
Report is 36 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b84b51f...2af4049. Read the comment docs.

Copy link
Member

@brobro10000 brobro10000 left a 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?

Comment on lines +40 to +44
"@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"
Copy link
Member

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?

Copy link
Member Author

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.

Copy link
Member

@brobro10000 brobro10000 Feb 24, 2025

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.

Copy link
Member Author

@adamstankiewicz adamstankiewicz Feb 24, 2025

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.

@adamstankiewicz adamstankiewicz merged commit 8b2d8f8 into master Feb 24, 2025
9 checks passed
@adamstankiewicz adamstankiewicz deleted the ags/react-18-hotjar branch February 24, 2025 21:54
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.

2 participants