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 and move RTL to peerDep vs regular dep #439

Merged
merged 2 commits into from
Feb 26, 2025

Conversation

adamstankiewicz
Copy link
Member

BREAKING CHANGE: Requires @testing-library/react@^16 as a peer dependency
feat: support React 18

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.

Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.99%. Comparing base (08c848a) to head (7409715).
Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #439   +/-   ##
=======================================
  Coverage   78.99%   78.99%           
=======================================
  Files          37       37           
  Lines         757      757           
  Branches      191      191           
=======================================
  Hits          598      598           
  Misses        146      146           
  Partials       13       13           

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 08c848a...7409715. Read the comment docs.

@@ -37,22 +37,24 @@
},
"sideEffects": false,
"dependencies": {
"@testing-library/react": "12.1.5",
Copy link
Member Author

@adamstankiewicz adamstankiewicz Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[inform] Moved to peerDeps.

BREAKING CHANGE: rely on the package installed by the MFE vs. installing its own copy (reduce to one copy vs. keep around two).

That said, continues to support v11 (used in frontend-app-admin-portal) thru the latest v16 (to be used with React 18 in frontend-app-learner-portal-enterprise).

BREAKING CHANGE: Requires @testing-library/react as a peer dependency (>12.0.0 <17.0.0)
feat: support React 18
@adamstankiewicz adamstankiewicz changed the title feat: support react 18 and move RTL to peerDep vs regular dep feat!: support react 18 and move RTL to peerDep vs regular dep Feb 26, 2025
@adamstankiewicz adamstankiewicz changed the title feat!: support react 18 and move RTL to peerDep vs regular dep feat: support react 18 and move RTL to peerDep vs regular dep Feb 26, 2025
@adamstankiewicz
Copy link
Member Author

Published to @adamstankiewicz/openedx-frontend-enterprise-utils@^10.0.1 for testing in both Learner Portal (React 18) and Admin Portal (React 17).

@adamstankiewicz adamstankiewicz merged commit ee48b25 into master Feb 26, 2025
9 checks passed
@adamstankiewicz adamstankiewicz deleted the ags/utils-react-18 branch February 26, 2025 02:08
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.

1 participant