Merge pull request #687 from etn-ccis/feat/update-dev-review-items

Prepare dev for release
etn-ccis · Dec 23, 2024 · fef9bf6 · fef9bf6
2 parents bca9a6b + fc41806
commit fef9bf6
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 80 deletions.
diff --git a/login-workflow/CHANGELOG.md b/login-workflow/CHANGELOG.md
@@ -5,11 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## v5.1.0 (December 20, 2024)
+## v6.0.0 (December 23, 2024)
 
 ### Changed
 
--   Updated styles to use the new MUI 6.
+-   Updated styles to use the new MUI v6 and requires [brightlayer-ui react-components 7.0.0](https://www.npmjs.com/package/@brightlayer-ui/react-components/v/7.0.0) and [brightlayer-ui react-theme 8.0.0](https://www.npmjs.com/package/@brightlayer-ui/react-themes/v/8.0.0)
 
 ### Fixed
 

diff --git a/login-workflow/README.md b/login-workflow/README.md
@@ -66,6 +66,15 @@ In short, you will need to:
 -   [Components & APIs](https://github.com/etn-ccis/blui-react-workflows/tree/master/login-workflow/docs/components/README.md)
 -   [Screens](https://github.com/etn-ccis/blui-react-workflows/tree/master/login-workflow/docs/screens/README.md)
 
+# Migrating from v5 => v6
+
+The migration to v6 from v5 should be very straightforward — all usage remains the same if you are using the custom login flow. However, version 6 has introduced new MUI v6. And two new peer dependencies that you will need to install:
+
+```
+"@mui/icons-material": "^6.1.4",
+"@mui/material": "^6.1.4",
+```
+
 # Migrating from v4 => v5
 
 The migration to v5 from v4 should be very straightforward — all usage remains the same if you are using the custom login flow. However, version 5 has two new peer dependencies that you will need to install:

diff --git a/login-workflow/docs/theme.md b/login-workflow/docs/theme.md
diff --git a/login-workflow/package.json b/login-workflow/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@brightlayer-ui/react-auth-workflow",
-    "version": "5.1.0",
+    "version": "6.0.0",
     "author": "Brightlayer UI <[email protected]> (https://github.com/brightlayer-ui)",
     "license": "BSD-3-Clause",
     "description": "Re-usable workflow components for Authentication and Registration within Eaton applications.",