-
Notifications
You must be signed in to change notification settings - Fork 836
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds a changelog with previous release information. closes #15234
- Loading branch information
1 parent
d1b9cd6
commit 0f6d5cb
Showing
1 changed file
with
306 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,306 @@ | ||
| # Release History | ||
|
|
||
| ## v0.19.0-beta.1 (Unreleased) | ||
|
|
||
| ### Features Added | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| ### Bugs Fixed | ||
|
|
||
| ### Other Changes | ||
|
|
||
| ## v0.18.0 | ||
| ### Features Added | ||
| * Replaces methods from Logger type with two package methods for interacting with the logging functionality. | ||
| * `azcore.SetClassifications` replaces `azcore.Logger().SetClassifications` | ||
| * `azcore.SetListener` replaces `azcore.Logger().SetListener` | ||
|
|
||
| ### Breaking Changes | ||
| * Removes `Logger` type from `azcore` | ||
|
|
||
|
|
||
| ## v0.17.0 | ||
| ### Features Added | ||
| * Adding TenantID to TokenRequestOptions (https://github.com/Azure/azure-sdk-for-go/pull/14879) | ||
| * Adding AuxiliaryTenants to AuthenticationOptions (https://github.com/Azure/azure-sdk-for-go/pull/15123) | ||
|
|
||
| ### Breaking Changes | ||
| * Rename `AnonymousCredential` to `NewAnonymousCredential` (https://github.com/Azure/azure-sdk-for-go/pull/15104) | ||
| * rename `AuthenticationPolicyOptions` to `AuthenticationOptions` (https://github.com/Azure/azure-sdk-for-go/pull/15103) | ||
| * Make Header constants private (https://github.com/Azure/azure-sdk-for-go/pull/15038) | ||
|
|
||
|
|
||
| ## v0.16.2 | ||
| ### Features Added | ||
| * Improved support for byte arrays [#14715](https://github.com/Azure/azure-sdk-for-go/pull/14715) | ||
|
|
||
|
|
||
| ## v0.16.1 | ||
| ### Features Added | ||
| * Add license.txt to azcore module [#14682](https://github.com/Azure/azure-sdk-for-go/pull/14682) | ||
|
|
||
|
|
||
| ## v0.16.0 | ||
| ### Features Added | ||
| * Remove extra `*` in UnmarshalAsByteArray() [#14642](https://github.com/Azure/azure-sdk-for-go/pull/14642) | ||
|
|
||
|
|
||
| ## v0.15.1 | ||
| ### Features Added | ||
| * Cache the original request body on Request [#14634](https://github.com/Azure/azure-sdk-for-go/pull/14634) | ||
|
|
||
|
|
||
| ## v0.15.0 | ||
| ### Features Added | ||
| * Add support for null map and slice | ||
| * Export `Response.Payload` method | ||
|
|
||
| ### Breaking Changes | ||
| * remove `Response.UnmarshalError` as it's no longer required | ||
|
|
||
|
|
||
| ## v0.14.5 | ||
| ### Features Added | ||
| * Add `UnmarshalError()` on `azcore.Response` | ||
|
|
||
|
|
||
| ## v0.14.4 | ||
| ### Features Added | ||
| * Support for basic LRO polling | ||
| * Added type `LROPoller` and supporting types for basic polling on long running operations. | ||
| * rename poller param and added doc comment | ||
|
|
||
| ### Bugs Fixed | ||
| * Fixed content type detection bug in logging. | ||
|
|
||
|
|
||
| ## v0.14.3 | ||
| ### Features Added | ||
| * Add support for multi-part form data | ||
| * Added method `WriteMultipartFormData()` to Request. | ||
|
|
||
|
|
||
| ## v0.14.2 | ||
| ### Features Added | ||
| * Add support for encoding JSON null values | ||
| * Adds `NullValue()` and `IsNullValue()` functions for setting and detecting sentinel values used for encoding a JSON null. | ||
| * Documentation fixes | ||
|
|
||
| ### Bugs Fixed | ||
| * Fixed improper error wrapping | ||
|
|
||
|
|
||
| ## v0.14.1 | ||
| ### Features Added | ||
| * Add `Pager` and `Poller` interfaces to azcore | ||
|
|
||
|
|
||
| ## v0.14.0 | ||
| ### Features Added | ||
| * Accept zero-value options for default values | ||
| * Specify zero-value options structs to accept default values. | ||
| * Remove `DefaultXxxOptions()` methods. | ||
| * Do not silently change TryTimeout on negative values | ||
| * make per-try timeout opt-in | ||
|
|
||
|
|
||
| ## v0.13.4 | ||
| ### Features Added | ||
| * Include telemetry string in User Agent | ||
|
|
||
|
|
||
| ## v0.13.3 | ||
| ### Features Added | ||
| * Updating response body handling on `azcore.Response` | ||
|
|
||
|
|
||
| ## v0.13.2 | ||
| ### Features Added | ||
| * Remove implementation of stateless policies as first-class functions. | ||
|
|
||
|
|
||
| ## v0.13.1 | ||
| ### Features Added | ||
| * Add `Telemetry()` method to `azcore.Request()` | ||
|
|
||
|
|
||
| ## v0.13.0 | ||
| ### Features Added | ||
| * Rename `log` to `logger` to avoid name collision with the log package. | ||
| * Documentation improvements | ||
| * Simplified `DefaultHTTPClientTransport()` implementation | ||
|
|
||
|
|
||
| ## v0.12.1 | ||
| ### Features Added | ||
| * Update `internal` module dependence to `v0.5.0` | ||
|
|
||
|
|
||
| ## v0.12.0 | ||
| ### Features Added | ||
| * Removed storage specific content | ||
| * Removed internal content to prevent API clutter | ||
| * Refactored various policy options to conform with our options pattern | ||
|
|
||
|
|
||
| ## v0.11.0 | ||
| ### Features Added | ||
|
|
||
| * Removed `LogError` and `LogSlowResponse`. | ||
| * Renamed `options` in `RequestLogOptions`. | ||
| * Updated `NewRequestLogPolicy()` to follow standard pattern for options. | ||
| * Refactored `requestLogPolicy.Do()` per above changes. | ||
| * Cleaned up/added logging in retry policy. | ||
| * Export `NewResponseError()` | ||
| * Fix `RequestLogOptions` comment | ||
|
|
||
|
|
||
| ## v0.10.1 | ||
| ### Features Added | ||
| * Add default console logger | ||
| * Default console logger writes to stderr. To enable it, set env var `AZURE_SDK_GO_LOGGING` to the value 'all'. | ||
| * Added `Logger.Writef()` to reduce the need for `ShouldLog()` checks. | ||
| * Add `LogLongRunningOperation` | ||
|
|
||
|
|
||
| ## v0.10.0 | ||
| ### Features Added | ||
| * The `request` and `transport` interfaces have been refactored to align with the patterns in the standard library. | ||
| * `NewRequest()` now uses `http.NewRequestWithContext()` and performs additional validation, it also requires a context parameter. | ||
| * The `Policy` and `Transport` interfaces have had their context parameter removed as the context is associated with the underlying `http.Request`. | ||
| * `Pipeline.Do()` will validate the HTTP request before sending it through the pipeline, avoiding retries on a malformed request. | ||
| * The `Retrier` interface has been replaced with the `NonRetriableError` interface, and the retry policy updated to test for this. | ||
| * `Request.SetBody()` now requires a content type parameter for setting the request's MIME type. | ||
| * moved path concatenation into `JoinPaths()` func | ||
|
|
||
|
|
||
| ## v0.9.6 | ||
| ### Features Added | ||
| * Improvements to body download policy | ||
| * Always download the response body for error responses, i.e. HTTP status codes >= 400. | ||
| * Simplify variable declarations | ||
|
|
||
|
|
||
| ## v0.9.5 | ||
| ### Features Added | ||
| * Set the Content-Length header in `Request.SetBody` | ||
|
|
||
|
|
||
| ## v0.9.4 | ||
| ### Features Added | ||
| * Fix cancellation of per try timeout | ||
| * Per try timeout is used to ensure that an HTTP operation doesn't take too long, e.g. that a GET on some URL doesn't take an inordinant amount of time. | ||
| * Once the HTTP request returns, the per try timeout should be cancelled, not when the response has been read to completion. | ||
| * Do not drain response body if there are no more retries | ||
| * Do not retry non-idempotent operations when body download fails | ||
|
|
||
|
|
||
| ## v0.9.3 | ||
| ### Features Added | ||
| * Add support for custom HTTP request headers | ||
| * Inserts an internal policy into the pipeline that can extract HTTP header values from the caller's context, adding them to the request. | ||
| * Use `azcore.WithHTTPHeader` to add HTTP headers to a context. | ||
| * Remove method specific to Go 1.14 | ||
|
|
||
|
|
||
| ## v0.9.2 | ||
| ### Features Added | ||
| * Omit read-only content from request payloads | ||
| * If any field in a payload's object graph contains `azure:"ro"`, make a clone of the object graph, omitting all fields with this annotation. | ||
| * Verify no fields were dropped | ||
| * Handle embedded struct types | ||
| * Added test for cloning by value | ||
| * Add messages to failures | ||
|
|
||
|
|
||
| ## v0.9.1 | ||
| ### Features Added | ||
| * Updated dependency on internal module to fix race condition. | ||
|
|
||
|
|
||
| ## v0.9.0 | ||
| ### Features Added | ||
| * Add `HTTPResponse` interface to be used by callers to access the raw HTTP response from an error in the event of an API call failure. | ||
| * Updated `sdk/internal` dependency to latest version. | ||
| * Rename package alias | ||
|
|
||
|
|
||
| ## v0.8.2 | ||
| ### Features Added | ||
| * Added missing documentation comments | ||
|
|
||
| ### Bugs Fixed | ||
| * Fixed a bug in body download policy. | ||
|
|
||
|
|
||
| ## v0.8.1 | ||
| ### Features Added | ||
| * Miscellaneous clean-up reported by linters | ||
|
|
||
|
|
||
| ## v0.8.0 | ||
| ### Features Added | ||
| * Differentiate between standard and URL encoding. | ||
|
|
||
|
|
||
| ## v0.7.1 | ||
| ### Features Added | ||
| * Add support for for base64 encoding and decoding of payloads. | ||
|
|
||
|
|
||
| ## v0.7.0 | ||
| ### Features Added | ||
| * Change `RetryAfter()` to a function. | ||
|
|
||
|
|
||
| ## v0.6.0 | ||
| ### Features Added | ||
| * Updating `RetryAfter` to only return the detaion in the RetryAfter header | ||
|
|
||
|
|
||
| ## v0.5.0 | ||
| ### Features Added | ||
| * Export `TransportFunc` | ||
|
|
||
| ### Breaking Changes | ||
| * Removed `IterationDone` | ||
|
|
||
|
|
||
| ## v0.4.1 | ||
| ### Features Added | ||
| * Ensure per-try timeout is properly cancelled | ||
| * Explicitly call cancel the per-try timeout when the response body has been read/closed by the body download policy. | ||
| * When the response body is returned to the caller for reading/closing, wrap it in a `responseBodyReader` that will cancel the timeout when the body is closed. | ||
| * `Logger.Should()` will return false if no listener is set. | ||
|
|
||
|
|
||
| ## v0.4.0 | ||
| ### Features Added | ||
| * Enable custom `RetryOptions` to be specified per API call | ||
| * Added `WithRetryOptions()` that adds a custom `RetryOptions` to the provided context, allowing custom settings per API call. | ||
| * Remove 429 from the list of default HTTP status codes for retry. | ||
| * Change StatusCodesForRetry to a slice so consumers can append to it. | ||
| * Added support for retry-after in HTTP-date format. | ||
| * Cleaned up some comments specific to storage. | ||
| * Remove `Request.SetQueryParam()` | ||
| * Renamed `MaxTries` to `MaxRetries` | ||
|
|
||
| ## v0.3.0 | ||
| ### Features Added | ||
| * Added `DefaultRetryOptions` to create initialized default options. | ||
|
|
||
| ### Breaking Changes | ||
| * Removed `Response.CheckStatusCode()` | ||
|
|
||
|
|
||
| ## v0.2.0 | ||
| ### Features Added | ||
| * Add support for marshalling and unmarshalling JSON | ||
| * Removed `Response.Payload` field | ||
| * Exit early when unmarsahlling if there is no payload | ||
|
|
||
|
|
||
| ## v0.1.0 | ||
| ### Features Added | ||
| * Initial release |