From d390ff17333034e2a87ddd38d75801b0ce547a5f Mon Sep 17 00:00:00 2001 From: jannyHou Date: Fri, 6 Sep 2019 14:43:41 -0400 Subject: [PATCH] fix(authentication): add breaking change notice BREAKING CHANGE: PR #3590 rewrote type UserProfile, add the missing breaking change tag here to amend the one in #3590 --- packages/authentication/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/packages/authentication/README.md b/packages/authentication/README.md index 851420bc1172..e3882c9fd5e8 100644 --- a/packages/authentication/README.md +++ b/packages/authentication/README.md @@ -53,6 +53,14 @@ For a tutorial on how to add **JWT** authentication to an application, see For some background on our design decisions, please read [Multiple Authentication strategies](./docs/authentication-system.md). +## Note + +Starting from version `@loobpack/authentication@3.0.0`, `UserProfile` needs to +be imported from @loopback/security and it's not backward compatible with the +one exported from `@loobpack/authentication@2.x`. Make sure you follow the +[new tutorial](https://loopback.io/doc/en/lb4/Loopback-component-authentication.html) +to build the authentication system. + ## Contributions - [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md)