refactor(provider): Mark ClientID as deprecated, use correct one in examples. #8
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the top-level ClientID field in CredentialsProviderOptions, removes its usage from tests and examples, and updates documentation and examples to use the correct per-provider client ID fields. It also adds a minimal, scope-less example for system-assigned managed identity.
- Deprecate and hide
CredentialsProviderOptions.ClientIDand add fallback inNewConfidentialCredentialsProvider. - Remove
ClientIDsettings from tests and examples; update README to reflect new usage. - Introduce a new minimal example (
managedidentity_systemassigned_min) demonstrating system-assigned identity without scopes.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| providers.go | Mark ClientID deprecated, update doc comment, add fallback logic in NewConfidentialCredentialsProvider. |
| providers_test.go & credentials_provider_test.go | Remove deprecated ClientID assignments from test cases. |
| examples/entraid/managedidentity_userassigned/main.go | Remove deprecated ClientID from user-assigned identity example. |
| examples/entraid/managedidentity_systemassigned/main.go | Switch hard-coded "SystemAssigned" string to identity.SystemAssignedIdentity. |
| examples/entraid/managedidentity_systemassigned_min/* | Add new minimal example (code + go.mod) for system-assigned managed identity without scopes. |
| README.md | Update all references to ClientID in examples and docs; remove top-level client ID usage. |
- go-redis-entraid will be replaced with current implementation anyway - the example runner (run_examples.sh) will update go-redis to the latest version
0781944 to
06847a5
Compare
Merging this branch will increase overall coverage
Coverage by fileChanged files (no unit tests)
Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code. Changed unit test files
|
htemelski-redis
approved these changes
May 30, 2025
htemelski
approved these changes
May 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update README and documentation.
There is no need to have
ClientIDin theCredentialsProviderOptionssince it is available in theConfidentialIdentityProviderOptionswhere it is actually needed.Add additional example test with minimal configuration (without scopes) for SystemManagedIdentityProvider