Skip to content

Commit 24c11e5

Browse files
committed
chore(documentation): Add release notes, add todo
1 parent 668586e commit 24c11e5

File tree

3 files changed

+26
-5
lines changed

3 files changed

+26
-5
lines changed

RELEASE_NOTES.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,35 @@
1-
# v1.0.1
1+
# v1.0.3 (2025-05-30)
2+
3+
## Introduction
4+
5+
ClientID in CredentialsProviderOptions is not used and will be removed in a future version.
6+
The correct one to use is the one in the identity provider options (e.g. ConfidentialIdentityProviderOptions).
7+
8+
## Changes
9+
10+
## 🧰 Maintenance
11+
12+
- refactor(provider): Mark ClientID as deprecated, use correct one in examples. ([#8](https://github.com/redis/go-redis-entraid/pull/8))
13+
14+
## Compatibility
15+
16+
- Go: 1.23+
17+
- go-redis: v9.9.0+
18+
19+
# v1.0.2 (2025-05-29)
220

321
## Changes
422

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

927
## Compatibility
1028

1129
- Go: 1.23+
1230
- go-redis: v9.9.0+
1331

14-
# v1.0.0
32+
# v1.0.0 (2025-05-27)
1533

1634
## Introduction
1735

examples/entraid/clientcert/main.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ func main() {
3636
// Create a confidential identity credentials provider with certificate authentication
3737
cp, err := entraid.NewConfidentialCredentialsProvider(entraid.ConfidentialCredentialsProviderOptions{
3838
CredentialsProviderOptions: entraid.CredentialsProviderOptions{
39+
ClientID: cfg.AzureClientID,
3940
TokenManagerOptions: manager.TokenManagerOptions{
4041
ExpirationRefreshRatio: 0.001, // Set to refresh very early
4142
LowerRefreshBound: time.Second * 1, // Set lower bound to 1 second

providers.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ type CredentialsProviderOptions struct {
1717
//
1818
// Deprecated: This field is not used and will be removed in a future version.
1919
// The ClientID should be part of the IdentityProvider options (e.g. ConfidentialIdentityProviderOptions, not the CredentialsProviderOptions)
20-
// There is a ClientID in the ConfidentialIdentityProviderOptions and ManagedIdentityProviderOptions.
20+
// There is a ClientID in the ConfidentialIdentityProviderOptions that is a required field and should be set by the user.
21+
// TODO(ndyakov): Remove this in v2.0.0
2122
ClientID string
2223

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

0 commit comments

Comments
 (0)