From 752642e2f3ad3798afc686d4649251e13fea4b20 Mon Sep 17 00:00:00 2001 From: Leon Linhart Date: Wed, 27 Jul 2022 14:32:51 +0200 Subject: [PATCH] chore: prepare 0.4.0 release --- docs/changelog/0.4.0.md | 2 +- docs/changelog/README.md | 4 ++-- docs/changelog/full.md | 29 +++++++++++++++++++++++++++++ docs/changelog/latest.md | 25 +++++++++++++++++++++---- 4 files changed, 53 insertions(+), 7 deletions(-) diff --git a/docs/changelog/0.4.0.md b/docs/changelog/0.4.0.md index d14ac080..7bb556bb 100644 --- a/docs/changelog/0.4.0.md +++ b/docs/changelog/0.4.0.md @@ -1,6 +1,6 @@ ### 0.4.0 -_Not Released Yet_ +_Released 2022 Jul 27_ #### Improvements diff --git a/docs/changelog/README.md b/docs/changelog/README.md index fb9148d6..9e7d652b 100644 --- a/docs/changelog/README.md +++ b/docs/changelog/README.md @@ -4,8 +4,8 @@ ### Version History -* ????-??-?? [0.4.0](0.4.0.md) (TBD; work in progress) -* 2021-07-14 [0.3.0](0.3.0.md) (latest) +* 2022-07-27 [0.4.0](0.4.0.md) (latest) +* 2021-07-14 [0.3.0](0.3.0.md) * 2021-01-25 [0.2.0](0.2.0.md) * 2020-12-24 [0.1.0](0.1.0.md) diff --git a/docs/changelog/full.md b/docs/changelog/full.md index 9a1facac..ee5f2aff 100644 --- a/docs/changelog/full.md +++ b/docs/changelog/full.md @@ -1,3 +1,32 @@ +### 0.4.0 + +_Released 2022 Jul 27_ + +#### Improvements + +- Updated to [api-generator](https://github.com/GW2ToolBelt/api-generator) to [0.6.0](https://github.com/GW2ToolBelt/api-generator/releases/tag/v0.6.0). +- Cleaned up caching. + - Renamed `CacheAccessor` to `CacheAccess`. + - Cache time overwrites were removed for now. +- Cleaned up the `RateLimiter` interface and related hooks. + - A default `TokenBucketRateLimiter` implementation is now available. + - API clients are now configured to use a rate limiter by default. +- Introduced the `DecodingResult` abstraction to improve error-handling + capabilities for malformed data from the API. +- Introduced the `ResponseHeaders` abstraction that wraps headers of a + `Response` and provides utilities. +- Improved documentation throughout the entire library. + +#### Breaking Changes + +- All modules now require Kotlin 1.7 +- JVM modules now require Java 11 +- The library was significantly reworked and many things were either renamed or + relocated. Detailed migration guidelines are not available for this release. + + +--- + ### 0.3.0 _Released 2021 Jul 14_ diff --git a/docs/changelog/latest.md b/docs/changelog/latest.md index c25a686c..108d5c2d 100644 --- a/docs/changelog/latest.md +++ b/docs/changelog/latest.md @@ -1,8 +1,25 @@ -### 0.3.0 +### 0.4.0 -_Released 2021 Jul 14_ +_Released 2022 Jul 27_ #### Improvements -- Updated to [api-generator](https://github.com/GW2ToolBelt/api-generator) to [0.4.0](https://github.com/GW2ToolBelt/api-generator/releases/tag/v0.4.0). -- `Result` is now used to catch exceptions during deserialization. \ No newline at end of file +- Updated to [api-generator](https://github.com/GW2ToolBelt/api-generator) to [0.6.0](https://github.com/GW2ToolBelt/api-generator/releases/tag/v0.6.0). +- Cleaned up caching. + - Renamed `CacheAccessor` to `CacheAccess`. + - Cache time overwrites were removed for now. +- Cleaned up the `RateLimiter` interface and related hooks. + - A default `TokenBucketRateLimiter` implementation is now available. + - API clients are now configured to use a rate limiter by default. +- Introduced the `DecodingResult` abstraction to improve error-handling + capabilities for malformed data from the API. +- Introduced the `ResponseHeaders` abstraction that wraps headers of a + `Response` and provides utilities. +- Improved documentation throughout the entire library. + +#### Breaking Changes + +- All modules now require Kotlin 1.7 +- JVM modules now require Java 11 +- The library was significantly reworked and many things were either renamed or + relocated. Detailed migration guidelines are not available for this release. \ No newline at end of file