Release notes for 3.1.1 should better describe the breaking change

[cody-watkins]

Describe the issue

Existing user code that relies on GenerateDeviceVerifier() will break in 3.1.1 because the "username" param for that method is changed to the "deviceKey". They are both strings, so the user code will continue to build after updating the Nuget pacakage, but attempting to login in using Cognito with an existing device will break.

The release notes should provide further description on the breaking change to help end users.

Links

https://github.com/aws/aws-sdk-net-extensions-cognito/blob/main/CHANGELOG.md

[AlexDaines]

Hey Cody, thank you for bringing this to our attention. I made an an amendment to the changelog to make sure this is communicated.

See: #201

[GarrettBeatty]

this has been merged in and the github release notes and changelog have been updated

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.