fix: include breaking change details in changelog (gh issue #200) #201
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR improves the changelog documentation for version 3.1.1 by explicitly marking a parameter rename as a breaking change and providing clear migration guidance for developers.
- Adds explicit "BREAKING CHANGE" marking to the changelog entry
- Clarifies that the
GenerateDeviceVerifier()method's third parameter was renamed fromusernametodeviceKey - Provides specific guidance about the runtime failure risk and required code updates
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
GarrettBeatty
added
the
Release Not Needed
GarrettBeatty
approved these changes
Aug 13, 2025
philasmar
approved these changes
Aug 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
#200
Description of changes:
Clarifies the breaking change in v3.1.1 by explicitly marking it as a BREAKING CHANGE and explaining the parameter rename in GenerateDeviceVerifier() method.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.