Skip to content

chore(documentation): Add release notes, add todo #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,35 @@
# v1.0.1
# v1.0.3 (2025-05-30)

## Introduction

ClientID in CredentialsProviderOptions is not used and will be removed in a future version.
The correct one to use is the one in the identity provider options (e.g. ConfidentialIdentityProviderOptions).

## Changes

## 🧰 Maintenance

- refactor(provider): Mark ClientID as deprecated, use correct one in examples. ([#8](https://github.com/redis/go-redis-entraid/pull/8))

## Compatibility

- Go: 1.23+
- go-redis: v9.9.0+

# v1.0.2 (2025-05-29)

## Changes

- fix(manager): optimize durationToRenewal @ndyakov (#6)
- chore(documentation): add release notes, add badges in readme (#7)
- fix(manager): optimize durationToRenewal ([#6](https://github.com/redis/go-redis-entraid/pull/6))
- chore(documentation): add release notes, add badges in readme ([#7](https://github.com/redis/go-redis-entraid/pull/7))
- chore(dependencies): update dependencies

## Compatibility

- Go: 1.23+
- go-redis: v9.9.0+

# v1.0.0
# v1.0.0 (2025-05-27)

## Introduction

Expand Down
4 changes: 3 additions & 1 deletion providers.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ type CredentialsProviderOptions struct {
//
// Deprecated: This field is not used and will be removed in a future version.
// The ClientID should be part of the IdentityProvider options (e.g. ConfidentialIdentityProviderOptions, not the CredentialsProviderOptions)
// There is a ClientID in the ConfidentialIdentityProviderOptions and ManagedIdentityProviderOptions.
// There is a ClientID in the ConfidentialIdentityProviderOptions that is a required field and should be set by the user.
// TODO(ndyakov): Remove this in v2.0.0
ClientID string

// TokenManagerOptions is the options for the token manager.
Expand Down Expand Up @@ -102,6 +103,7 @@ type ConfidentialCredentialsProviderOptions struct {
func NewConfidentialCredentialsProvider(options ConfidentialCredentialsProviderOptions) (auth.StreamingCredentialsProvider, error) {
// If the client ID is not provided in the confidential identity provider options, use the one from the credentials provider options.
// Those are duplicated and should be the same and the one in the credentials provider options is deprecated.
// TODO(ndyakov): Remove this in a version v2.0.0 when ClientID is removed from CredentialsProviderOptions.
if options.ConfidentialIdentityProviderOptions.ClientID == "" {
options.ConfidentialIdentityProviderOptions.ClientID = options.CredentialsProviderOptions.ClientID
}
Expand Down
Loading