Skip to content

Commit

Permalink
Add changelog for 1.2.0 release, update version in CMake (#629)
Browse files Browse the repository at this point in the history
Resolves: OLPEDGE-1400

Signed-off-by: Mykhailo Kuchma <ext-mykhailo.kuchma@here.com>
  • Loading branch information
mykhailo-kuchma authored Feb 4, 2020
1 parent c30c405 commit 265a5f8
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 8 deletions.
43 changes: 43 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,64 @@
## v1.2.0 (04/02/2020)

**Common**

* Added a protected read-only cache. For details, see `olp::cache::CacheSettings`.
* Added a protected read-only cache [usage example](https://github.com/heremaps/here-olp-sdk-cpp/blob/c30c4051ec012eaca09b7aa7ba4c7e8f6cd7a576/docs/dataservice-cache-example.md).
* Added ARM platform support for Embedded Linux with GCC 5.4 (32/64 bit).
* Added the `ErrorCodeToString` function to olp/core/http/NetworkTypes.h.
* Improved the `olp::http::NetworkCurl` logging.
* Changed the `IsNull` function in the `olp::client::HRN` class to handle realms according to platform changes.
* Added the bool operator to the `olp::client::HRN` class. You can now use the operator to check whether all the service type fields in the `olp::client::HRN` class are not empty.
* Fixed a possible data race in the `olp::client::Condition` class.
* Added the `MoveResult` method to the `olp::client::ApiResponse` class. The method returns an rvalue reference to the result.
* CMake now requires RapidJSON v1.1.0.
* Various CMake cleanups.
* Improved error handling in Android `HttpClient`.
* Fixed the linking error when SDK was statically linked inside a shared library with `CMAKE_POSITION_INDEPENDENT_CODE=ON`.
* The retry policy now handles server errors automatically.

**olp-cpp-sdk-authentication**

* Added a possibility to parse credentials from a file or stream in `olp::authentication::AuthenticationCredentials`. Now, to get credentials for the `AuthenticationCredentials` class, you can use the **credentials.properties** file that is provided by the platform.
* Deprecated the `olp::authentication::TokenEndpoint` class. It will be removed by 04.2020.
* Deprecated the `olp::authentication::TokenRequest` class. It will be removed by 04.2020.
* Deprecated various methods in `olp::authentication::AuthenticationClient`.
* Authentication now gets the current timestamp from the platform and uses it to request the OAuth2 token that prevents replay attacks. As a fallback, the system time is used.

**olp-cpp-sdk-dataservice-read**

* The `olp::dataservice::read::QueryApi`, `olp::dataservice::read::MetadataApi`, `olp::dataservice::read::LookupApi`, and `olp::dataservice::read::BlobApi` classes are now blocking and use the new synchronous `CallApi` method in `OlpClient`.
* The `GetData` method of the versioned and volatile layer now triggers the `olp::client::ErrorCode::PreconditionFailed` error if both a partition ID and data handle are passed in the data request.
* **Work-in-progress**: Added reading support for streamed data using the new `olp::dataservice::read::StreamLayerClient`. Currently, you can only subscribe, unsubscribe, and get data from a stream layer message.

**olp-cpp-sdk-dataservice-write**

* Enhanced `olp::dataservice::write::StreamLayerClient` to use `olp::thread::TaskScheduler` for asynchronous operations instead of network threads.
* Removed the unused `olp::dataservice::write::ThreadSafeQueue` class.
* Deprecated the `CancelAll` methods in all layers. Use the `CancelPendingRequests` methods instead.

## v1.1.0 (11/12/2019)

**Common**

* The deprecated `olp::client::CancellationToken::cancel()` method was removed. Use `olp::client::CancellationToken::Cancel()` instead.
* The `curl` network implementation was fixed and can now compile on 32 bits architecture.
* The `disk_path` field in `olp::cache::CacheSettings` is deprecated. Use the `disk_path_mutable` field instead.
* A new synchronous `CallApi` method was added to `olp::client::OlpClient`.
* `pipe` and `pipe2` symbols detection are enhanced in curl.cmake.

**olp-cpp-sdk-authentication**

* The `SignInClient` method in `olp::authentication::AuthenticationClient` is deprecated in favor of the newly introduced `SignInClient` method with a different signature.
* The `scope` support was added to OAuth2 through `olp::authentication::SignInProperties`. You can now access the project bound resources using the `olp::authentication::SignInProperties::scope` field.
* The `error_id` field was added to the `ErrorResponse` structure. You can use it to get the `errorId` string from the authentication error response.

**olp-cpp-sdk-dataservice-read**

* The deprecated `GetCatalogMetadataVersion` method was removed from the `olp::dataservice::read::CatalogClient`.

**olp-cpp-sdk-dataservice-write**

* Legacy and unused code were removed.

## v1.0.0 (03/12/2019)
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
cmake_minimum_required(VERSION 3.9)

# Build the sdk targets
project(olp-cpp-sdk VERSION 1.1.0)
project(olp-cpp-sdk VERSION 1.2.0)

# Add preprocessor definitions for the SDK version and platform name
add_definitions(-DOLP_SDK_VERSION_STRING=\"${olp-cpp-sdk_VERSION}\")
Expand Down
2 changes: 1 addition & 1 deletion examples/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ elseif(ANDROID)
${OLP_SDK_EXAMPLE_FAILURE_STRING})

else()
project(${OLP_SDK_DATASERVICE_EXAMPLE_TARGET} VERSION 1.1.0)
project(${OLP_SDK_DATASERVICE_EXAMPLE_TARGET} VERSION 1.2.0)

add_library(${OLP_SDK_DATASERVICE_READ_EXAMPLE_TARGET}
${CMAKE_CURRENT_SOURCE_DIR}/ReadExample.cpp
Expand Down
2 changes: 1 addition & 1 deletion examples/android/app/CMakeLists.txt.in
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

cmake_minimum_required(VERSION 3.5)

project(@OLP_SDK_EXAMPLE_TARGET_NAME@ VERSION 1.1.0)
project(@OLP_SDK_EXAMPLE_TARGET_NAME@ VERSION 1.2.0)

if (DEFINED OLP_SDK_HTTP_CLIENT_JAR)
get_filename_component(OLP_SDK_HTTP_CLIENT_JAR_FULL_PATH "${OLP_SDK_HTTP_CLIENT_JAR}" ABSOLUTE)
Expand Down
2 changes: 1 addition & 1 deletion examples/ios/CMakeLists.txt.in
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ if (NOT IOS)
message(FATAL_ERROR "Unsupported platform!")
endif()

project(@OLP_SDK_EXAMPLE_TARGET_NAME@ VERSION 1.1.0)
project(@OLP_SDK_EXAMPLE_TARGET_NAME@ VERSION 1.2.0)

add_executable(@OLP_SDK_EXAMPLE_TARGET_NAME@
${CMAKE_CURRENT_SOURCE_DIR}/ReadExample.h
Expand Down
2 changes: 1 addition & 1 deletion olp-cpp-sdk-authentication/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# SPDX-License-Identifier: Apache-2.0
# License-Filename: LICENSE

project(olp-cpp-sdk-authentication VERSION 1.1.0)
project(olp-cpp-sdk-authentication VERSION 1.2.0)
set(DESCRIPTION "C++ API library for accesing HERE Account authentication service")

file(GLOB_RECURSE AUTHENTICATION_INC "include/*.h*")
Expand Down
2 changes: 1 addition & 1 deletion olp-cpp-sdk-core/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# License-Filename: LICENSE


project(olp-cpp-sdk-core VERSION 1.1.0)
project(olp-cpp-sdk-core VERSION 1.2.0)
set(DESCRIPTION "Core network and utility library for the HERE OLP SDK C++")

find_package(RapidJSON 1.1.0 REQUIRED CMAKE_FIND_ROOT_PATH_BOTH)
Expand Down
2 changes: 1 addition & 1 deletion olp-cpp-sdk-dataservice-read/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# SPDX-License-Identifier: Apache-2.0
# License-Filename: LICENSE

project(olp-cpp-sdk-dataservice-read VERSION 1.1.0)
project(olp-cpp-sdk-dataservice-read VERSION 1.2.0)
set(DESCRIPTION "C++ API library for reading OLP data")

file(GLOB_RECURSE INC "include/*.h*")
Expand Down
2 changes: 1 addition & 1 deletion olp-cpp-sdk-dataservice-write/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# SPDX-License-Identifier: Apache-2.0
# License-Filename: LICENSE

project(olp-cpp-sdk-dataservice-write VERSION 1.1.0)
project(olp-cpp-sdk-dataservice-write VERSION 1.2.0)
set(DESCRIPTION "C++ API library for writing data to OLP")

set(OLP_SDK_DATASERVICE_WRITE_API_HEADERS
Expand Down

0 comments on commit 265a5f8

Please sign in to comment.