Release (2024-02-27)

Highlights

• core: v0.10.0
  • Feature: Add package runtime, which implements methods to be used when performing API requests.
  • Feature: Add method WithCaptureHTTPResponse to package runtime, which does the same as config.WithCaptureHTTPResponse. Method was moved to avoid confusion due to it not being a configuration option, and will be removed in a later release.
  • Feature: Add configuration option that, for the key flow, enables a goroutine to be spawned that will refresh the access token when it's close to expiring
  • Deprecation: Mark method config.WithCaptureHTTPResponse as deprecated, to avoid confusion due to it not being a configuration option. Use runtime.WithCaptureHTTPResponse instead.
  • Deprecation: Mark method config.WithJWKSEndpoint and field config.Configuration.JWKSCustomUrl as deprecated. Validation using JWKS was removed, for being redundant with token validation done in the APIs. These have no effect.
  • Deprecation:
    • Methods:
      • config.WithMaxRetries
      • config.WithWaitBetweenCalls
      • config.WithRetryTimeout
      • clients.NewRetryConfig
    • Fields:
      • clients.KeyFlowConfig.ClientRetry
      • clients.TokenFlowConfig.ClientRetry
      • clients.NoAuthFlowConfig.ClientRetry
      • clients.RetryConfig
    • Retry options removed to reduce complexity of the clients. If this functionality is needed, you can provide your own custom HTTP client.
  • Breaking Change: Change signature of auth.NoAuth, which no longer takes clients.RetryConfig as argument.
  • Breaking Change:
    • Methods:
      • clients.KeyFlow.Clone
      • clients.TokenFlow.Clone
      • clients.NoAuthFlow.Clone
      • clients.Do
    • Fields:
      • clients.DefaultRetryMaxRetries
      • clients.DefaultRetryWaitBetweenCalls
      • clients.DefaultRetryTimeout
    • Constants:
      • clients.ClientTimeoutErr
      • clients.ClientContextDeadlineErr
      • clients.ClientConnectionRefusedErr
      • clients.ClientEOFError
      • clients.Environment
    • Removed to reduce complexity of the clients, they were no longer being used.

What's Changed

• Replace membership example with authentication by @hcsa73 in #320
• Update module golang.org/x/oauth2 to v0.17.0 by @stackit-pipeline in #321
• Add LICENSE to root by @vicentepinto98 in #322
• Update GitHub actions by @joaopalet in #323
• Move WithCaptureHTTPResponse by @hcsa73 in #324
• Deprecate config.WithCaptureHTTPResponse by @hcsa73 in #325
• Update module github.com/stackitcloud/stackit-sdk-go/core to v0.8.0 by @stackit-pipeline in #326
• Remove token validation using JWKS in KeyFlow by @hcsa73 in #328
• Remove Key Flow unused methods by @hcsa73 in #327
• Undo removal of JWKSCustomUrl field by @hcsa73 in #330
• Remove golang.org/x/oauth2 core dependency by @joaopalet in #329
• Release 2024-02-19 by @hcsa73 in #331
• Update module github.com/stackitcloud/stackit-sdk-go/core to v0.9.0 by @stackit-pipeline in #332
• Add token refresh in background by @hcsa73 in #333
• Fix key flow bugs by @hcsa73 in #334
• Add example for background token refresh by @hcsa73 in #336
• Automatic tag helper script by @vicentepinto98 in #335
• Bump github.com/cloudflare/circl from 1.3.3 to 1.3.7 in /scripts by @dependabot in #338
• Update module golang.org/x/mod to v0.15.0 by @stackit-pipeline in #340
• Read password from terminal in automatic tag script by @vicentepinto98 in #339
• Remove backoff dependency and deprecate RetryOptions by @vicentepinto98 in #337
• Ask for confirmation in automatic script tags by @vicentepinto98 in #341

New Contributors

• @dependabot made their first contribution in #338

Full Changelog: release-2024-02-07...release-2024-02-27