iox-eclipse-iceoryx#828 Add section for API changes to Changelog

Documenting API breaking changes in the Changelog and give a hint in the PR template. Set the version number to 1.90.0 for the upcoming pre-releases of iceoryx 2.0
ApexAI · Jun 17, 2021 · 2ef08f4 · 2ef08f4
1 parent 2f574dc
commit 2ef08f4
Show file tree

Hide file tree

Showing 14 changed files with 68 additions and 14 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,7 +2,7 @@
 
 1. [ ] Code follows the coding style of [CONTRIBUTING.md][contributing]
 1. [ ] Tests follow the [best practice for testing][testing]
-1. [ ] Changelog updated [in the unreleased section][changelog]
+1. [ ] Changelog updated [in the unreleased section][changelog] including API breaking changes
 1. [ ] Branch follows the naming format (`iox-#123-this-is-a-branch`)
 1. [ ] Commits messages are according to this [guideline][commit-guidelines]
     - [ ] Commit messages have the issue ID (`iox-#123 commit text`)

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 [Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v1.0.1...master)
 
 **Features:**
+
 - Enhance posixCall[\#805](https://github.com/eclipse-iceoryx/iceoryx/issues/805)
 - New chunk available callback for the new C++[\#391](https://github.com/eclipse-iceoryx/iceoryx/issues/391)
 - Git Hooks on iceoryx[\#486](https://github.com/eclipse-iceoryx/iceoryx/issues/486)
@@ -13,11 +14,13 @@
 - Axivion analysis on CI[\#409](https://github.com/eclipse-iceoryx/iceoryx/issues/409)
 
 **Bugfixes:**
+
 - Fix warnings for gcc-11.1[\#838](https://github.com/eclipse-iceoryx/iceoryx/issues/838)
 - Incremental builds with the build script are broken[\#821](https://github.com/eclipse-iceoryx/iceoryx/issues/821)
 - Compile failed because of missing <limits> for GCC 11[\#811](https://github.com/eclipse-iceoryx/iceoryx/issues/811) thanks to @homalozoa
 
 **Refactoring:**
+
 - Move all tests into an anonymous namespace[\#563](https://github.com/eclipse-iceoryx/iceoryx/issues/563)
 - Refactor smart_c to use contract by design and expected[\#418](https://github.com/eclipse-iceoryx/iceoryx/issues/418)
 - PoshRuntime Mock[\#449](https://github.com/eclipse-iceoryx/iceoryx/issues/449)
@@ -27,11 +30,62 @@
 - Refine quality levels[\#425](https://github.com/eclipse-iceoryx/iceoryx/issues/425)
 - Clean-up std::terminate usage[\#261](https://github.com/eclipse-iceoryx/iceoryx/issues/261)
 
+**API Breaking Changes:**
+
+Rename utils to hoofs:
+
+- in CMake you need now to find and link the package `iceoryx_hoofs` instead of `iceoryx_utils`
+
+```cmake
+# before
+find_package(iceoryx_utils REQUIRED)
+target_link_libraries(${target}
+    iceoryx_utils::iceoryx_utils)
+
+# after
+find_package(iceoryx_hoofs REQUIRED)
+target_link_libraries(${target}
+    iceoryx_hoofs::iceoryx_hoofs)
+```
+
+- the include paths for `iceoryx_utils` are now `iceoryx_hoofs`
+
+```cpp
+// before
+#include "iceoryx_utils/cxx/string.hpp"
+
+// after
+#include "iceoryx_hoofs/cxx/string.hpp"
+```
+
+Enhance posixCall to handle a common case were errnos are ignored just to suppress error logging:
+
+```cpp
+// before
+iox::posix::posixCall(unlink)(sockAddrPublisher.sun_path)
+    .failureReturnValue(ERROR_CODE)
+    .evaluateWithIgnoredErrnos(ENOENT)
+    .or_else([](auto& r) {
+        std::cout << "unlink error " << r.getHumanReadableErrnum() << std::endl;
+        exit(1);
+    });
+
+// after
+iox::posix::posixCall(unlink)(sockAddrPublisher.sun_path)
+    .failureReturnValue(ERROR_CODE)
+    .ignoreErrnos(ENOENT) // can be a comma-separated list of errnos
+    .evaluate()
+    .or_else([](auto& r) {
+        std::cout << "unlink error " << r.getHumanReadableErrnum() << std::endl;
+        exit(1);
+    });
+```
+
 ## [v1.0.1](https://github.com/eclipse-iceoryx/iceoryx/tree/v1.0.0) (2021-06-15)
 
 [Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v1.0.0...v1.0.1)
 
-Description:
+**Description:**
 This is the first bugfix release for Eclipse iceoryx 1.0.0. We made minor changes in the documentation and added several patches.
 
 Compared to the feature content of the release 1.0.0, the following bug tickets where resolved:

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.0.0
+1.90.0
diff --git a/cmake/package/package.cmake b/cmake/package/package.cmake
@@ -14,7 +14,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
-set(IOX_VERSION_STRING "2.0.0")
+set(IOX_VERSION_STRING "1.90.0")
 
 project(iceoryx_package VERSION ${IOX_VERSION_STRING})
 

diff --git a/doc/aspice_swe3_4/CMakeLists.txt b/doc/aspice_swe3_4/CMakeLists.txt
@@ -16,7 +16,7 @@
 
 cmake_minimum_required(VERSION 3.10)
 
-set(IOX_VERSION_STRING "2.0.0")
+set(IOX_VERSION_STRING "1.90.0")
 
 #find_package(iceoryx_hoofs REQUIRED)
 

diff --git a/iceoryx_binding_c/CMakeLists.txt b/iceoryx_binding_c/CMakeLists.txt
@@ -16,7 +16,7 @@
 # SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.7)
 
-set(IOX_VERSION_STRING "2.0.0")
+set(IOX_VERSION_STRING "1.90.0")
 
 
 

diff --git a/iceoryx_binding_c/package.xml b/iceoryx_binding_c/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>iceoryx_binding_c</name>
-    <version>2.0.0</version>
+    <version>1.90.0</version>
     <description>Eclipse iceoryx inter-process-communication (IPC) middleware C-Language Binding</description>
     <maintainer email="[email protected]">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>

diff --git a/iceoryx_dds/CMakeLists.txt b/iceoryx_dds/CMakeLists.txt
@@ -16,7 +16,7 @@
 # SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.7)
 
-set(IOX_VERSION_STRING "2.0.0")
+set(IOX_VERSION_STRING "1.90.0")
 
 project(iceoryx_dds VERSION ${IOX_VERSION_STRING})
 

diff --git a/iceoryx_hoofs/CMakeLists.txt b/iceoryx_hoofs/CMakeLists.txt
@@ -17,7 +17,7 @@
 
 cmake_minimum_required(VERSION 3.5)
 
-set(IOX_VERSION_STRING "2.0.0")
+set(IOX_VERSION_STRING "1.90.0")
 
 
 #include("${CMAKE_CURRENT_LIST_DIR}/cmake/IceoryxVersion.cmake")

diff --git a/iceoryx_hoofs/package.xml b/iceoryx_hoofs/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>iceoryx_hoofs</name>
-    <version>2.0.0</version>
+    <version>1.90.0</version>
     <description>Eclipse iceoryx inter-process-communication (IPC) middleware basic building blocks</description>
     <maintainer email="[email protected]">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>

diff --git a/iceoryx_integrationtest/package.xml b/iceoryx_integrationtest/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>iceoryx_integrationtest</name>
-  <version>2.0.0</version>
+  <version>1.90.0</version>
   <description>iceoryx Software Integrationtest</description>
     <maintainer email="[email protected]">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>

diff --git a/iceoryx_posh/CMakeLists.txt b/iceoryx_posh/CMakeLists.txt
@@ -16,7 +16,7 @@
 # SPDX-License-Identifier: Apache-2.0
 cmake_minimum_required(VERSION 3.5)
 
-set(IOX_VERSION_STRING "2.0.0")
+set(IOX_VERSION_STRING "1.90.0")
 
 project(iceoryx_posh VERSION ${IOX_VERSION_STRING})
 

diff --git a/iceoryx_posh/package.xml b/iceoryx_posh/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>iceoryx_posh</name>
-    <version>2.0.0</version>
+    <version>1.90.0</version>
     <description>Eclipse iceoryx inter-process-communication (IPC) middleware Posix Shared Memory Library and middleware daemon (RouDi)</description>
     <maintainer email="[email protected]">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>

diff --git a/tools/introspection/CMakeLists.txt b/tools/introspection/CMakeLists.txt
@@ -17,7 +17,7 @@
 
 cmake_minimum_required(VERSION 3.5)
 
-set(IOX_VERSION_STRING "2.0.0")
+set(IOX_VERSION_STRING "1.90.0")
 
 project(iceoryx_introspection VERSION ${IOX_VERSION_STRING})