From 7b526daa07550357a0e819ff4f879a0b5fb06c96 Mon Sep 17 00:00:00 2001 From: Greg Medding Date: Fri, 12 Jul 2024 11:49:39 -0700 Subject: [PATCH 1/3] Dropping CONTRIBUTORS file based on feedback In eclipse-uprotocol/up-transport-zenoh-cpp#48 we were asked to remove this file. The list of contributors can be determined from commit history in the repo. --- CONTRIBUTORS.adoc | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 CONTRIBUTORS.adoc diff --git a/CONTRIBUTORS.adoc b/CONTRIBUTORS.adoc deleted file mode 100644 index 4945e4e73..000000000 --- a/CONTRIBUTORS.adoc +++ /dev/null @@ -1,14 +0,0 @@ -= Eclipse uProtocol Contributors - -These are the initial contributors to Eclipse uProtocol C++ SDK - -|=== -| GitHub username | Name - -|https://github.com/MelamudMichael[MelamudMichael] | Michael Melamud -|https://github.com/uzimeirov[uzimeirov] | Uzi Meirov -|https://github.com/adienzel[adienzel] | Adi -|https://github.com/giorgiozoppi[giorgiozoppi] | Giorgio Zoppi -|https://github.com/stevenhartley[stevenhartley] | Steven Hartley -|https://github.com/gregmedd[gregmedd] | Greg Medding -|=== From 9deeb2167b7499b696acd92cf0386567d0be2fdc Mon Sep 17 00:00:00 2001 From: Greg Medding Date: Fri, 12 Jul 2024 11:51:47 -0700 Subject: [PATCH 2/3] Updating README for clarity and using new build steps Build steps are based on capabilities from new(er) versions of cmake, simplifying the process of generating builds. Also adding a CI badge to the top of the README --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 222ad7c53..cc790eca3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # uProtocol C++ Interface Library (up-cpp) +[![Build & Test](https://github.com/eclipse-uprotocol/up-cpp/actions/workflows/ci.yml/badge.svg?branch=v1.0_up-v1.6.0)](https://github.com/eclipse-uprotocol/up-cpp/actions/workflows/ci.yml) + ## Welcome! This library provides the primary interface to uProtocol for uEntity @@ -56,30 +58,38 @@ up-cpp, If you are making a project that uses up-cpp, follow the steps in the ### With Conan for dependencies -Clone the up-cpp repo to a folder named: up-cpp +From the root of this repo, run: -``` -cd up-cpp -conan install . -cd build -cmake ../ -DCMAKE_TOOLCHAIN_FILE=Release/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release +```bash +conan install --build=missing . +cmake --preset conan-release +cd build/Release cmake --build . -- -j ``` Once the build completes, tests can be run with `ctest`. -### Generate UT Coverage +Debug builds can be generated by changing those steps to: -To get code coverage, perform the steps above, but use the following cmake line instead +```bash +conan install --build=missing --settings=build_type=Debug . +cmake --preset conan-debug +cd build/Debug +cmake --build . -- -j ``` -cmake ../ -DCMAKE_TOOLCHAIN_FILE=Release/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Coverage + +### Generate UT Coverage + +To get code coverage, perform the steps above, but replace `cmake --preset...` with +``` +cd build/Release +cmake ../../ -DCMAKE_TOOLCHAIN_FILE=generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Coverage ``` Once the tests complete, the Unit Test Coverage report can be generated from the base up-cpp folder with: ./Coverage.sh ``` ./coverage.sh ``` - ### With dependencies installed as system libraries **TODO** Verify steps for pure cmake build without Conan. From be60dd10327b4e120ca9efcb6ffe58eee9445924 Mon Sep 17 00:00:00 2001 From: Greg Medding Date: Fri, 12 Jul 2024 10:55:14 -0700 Subject: [PATCH 3/3] Updating library list in NOTICE.adoc The list was out of date and did not represent the actual usage of libraries in up-cpp. --- NOTICE.adoc | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/NOTICE.adoc b/NOTICE.adoc index a17e0df82..c79c2643c 100644 --- a/NOTICE.adoc +++ b/NOTICE.adoc @@ -27,10 +27,5 @@ SPDX-License-Identifier: Apache-2.0 The following are libraries used by this project: -* http://cloudevents.io -* https://github.com/google/googletest * http://protobuf.dev -* https://github.com/openssl/openssl -* https://github.com/topics/libuuid -* https://github.com/Tencent/rapidjson -* https://github.com/cgreen-devs/cgreen +* https://github.com/google/googletest