Update changelogs with links to migration guides (#7510)

Update changelogs to highlight the breaking changes and link to migration guides
AzureAD · Jan 15, 2025 · 69238d1 · 69238d1
1 parent 2b2ddb2
commit 69238d1
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/lib/msal-angular/CHANGELOG.md b/lib/msal-angular/CHANGELOG.md
@@ -8,11 +8,11 @@
 
 Wed, 15 Jan 2025 05:05:16 GMT
 
-### Patches
+### Breaking Changes
 
 - Update msal-browser peer dependency to include v4 ([email protected])
-- Bump @azure/msal-browser to v4.0.1
-- Bump eslint-config-msal to v0.0.0
+
+Please see the msal-browser [migration guide](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/v3-migration.md) for more details on what's changed in v4.
 
 ## 3.1.0
 

diff --git a/lib/msal-browser/CHANGELOG.md b/lib/msal-browser/CHANGELOG.md
@@ -8,14 +8,13 @@
 
 Wed, 15 Jan 2025 05:05:17 GMT
 
-### Patches
+### Breaking Changes
 
 - Rename `native` to `platformBroker` in public API and docs ([email protected])
 - Encrypt localStorage to reduce persistence to browser session lifetime ([email protected])
-- Bump @azure/msal-common to v15.0.1
-- Bump eslint-config-msal to v0.0.0
-- Bump msal-test-utils to v0.0.1
-- Bump rollup-msal to v0.0.0
+- Bump @azure/msal-common to v15.0.1 (beachball)
+
+Please see the [migration guide](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/v3-migration.md) for more details.
 
 ## 3.28.1
 

diff --git a/lib/msal-browser/docs/v3-migration.md b/lib/msal-browser/docs/v3-migration.md
@@ -66,4 +66,5 @@ Starting in v4, if you are using the `localStorage` cache location, auth artifac
 
 This cookie will be automatically removed when the browser instance (not tab) is closed, thus making it impossible to decrypt any auth artifacts after the session has ended. These expired auth artifacts will be removed the next time MSAL is initialized and the user may need to reauthenticate. The `localStorage` location still provides cross-tab cache persistence but will no longer persist across browser sessions.  
 
-> [!Important] The purpose of this encryption is to reduce the persistence of auth artifacts, **not** to provide additional security. If a bad actor gains access to browser storage they would also have access to the key or have the ability to request tokens on your behalf without the need for cache at all. It is your responsibility to ensure your application is not vulnerable to XSS attacks [see below](#security)
+> [!Important]
+> The purpose of this encryption is to reduce the persistence of auth artifacts, **not** to provide additional security. If a bad actor gains access to browser storage they would also have access to the key or have the ability to request tokens on your behalf without the need for cache at all. It is your responsibility to ensure your application is not vulnerable to XSS attacks [see below](#security)
diff --git a/lib/msal-node/CHANGELOG.md b/lib/msal-node/CHANGELOG.md
@@ -8,12 +8,11 @@
 
 Wed, 15 Jan 2025 05:05:17 GMT
 
-### Patches
+### Breaking Changes
 
-- Asynchronous cache writes ([email protected])
-- Bump @azure/msal-common to v15.0.1
-- Bump eslint-config-msal to v0.0.0
-- Bump rollup-msal to v0.0.0
+- NodeStorage is no longer exported
+
+Please see the [migration guide](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/v2-migration.md) for more details.
 
 ## 2.16.2
 

diff --git a/lib/msal-react/CHANGELOG.md b/lib/msal-react/CHANGELOG.md
@@ -8,12 +8,13 @@
 
 Wed, 15 Jan 2025 05:05:17 GMT
 
-### Patches
+### Breaking Changes
 
 - Update msal-browser peer dependency to include v4 ([email protected])
 - Rename `native` to `platformBroker` in public API and docs ([email protected])
 - Bump @azure/msal-browser to v4.0.1
-- Bump eslint-config-msal to v0.0.0
+
+- Please see the msal-browser [migration guide](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/v3-migration.md) for more details on what's changed in v4.
 
 ## 2.2.0