From e9b00bdbf53cfbbebfee2dc8105e6eed7f49f003 Mon Sep 17 00:00:00 2001 From: Abdessattar Sassi <457645+abdes@users.noreply.github.com> Date: Sat, 20 Aug 2022 19:41:21 +0400 Subject: [PATCH] version bump to 4.4.1 --- CHANGELOG.md | 185 ++++++++++++++++++++++++++----------------------- CMakeLists.txt | 2 +- 2 files changed, 98 insertions(+), 89 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a62d39..b78ff8f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,8 +4,17 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. -## [4.4.0](http://github.com/abdes/asap/compare/v4.3.6...v4.4.0) (2022-08-20) +## [4.4.1](http://github.com/abdes/asap/compare/v4.4.0...v4.4.1) (2022-08-20) + +### Bug Fixes +* [#12](http://github.com/abdes/asap/issues/12) disable used-but-marked-unused + ([6d42d83](http://github.com/abdes/asap/commit/6d42d83bfdd16123f05a69726058dc5f103143be)) + + For clang-tidy, this check generates many errors with google test framework + and as such is not worth the trouble. + +## [4.4.0](http://github.com/abdes/asap/compare/v4.3.6...v4.4.0) (2022-08-20) ### Bug Fixes @@ -34,7 +43,7 @@ for commit guidelines. ## [4.3.6](http://github.com/abdes/asap/compare/v4.3.5...v4.3.6) (2022-08-11) Minor update to directly use the `cmake/common` submodule from -https://github.com/swift-nav/cmake now that all asap fixes have been merged over + now that all asap fixes have been merged over there. ## [4.3.5](http://github.com/abdes/asap/compare/v4.3.4...v4.3.5) (2022-08-11) @@ -114,53 +123,53 @@ there. ### Features -- add ccache support to dev container +* add ccache support to dev container ([202c27a](http://github.com/abdes/asap/commit/202c27a628f7f35ae17f2df91c1d95f67360abea)) ## [4.3.0](http://github.com/abdes/asap/compare/v4.2.0...v4.3.0) (2022-04-07) ### Documentation -- add badge for OpenSSF best practices +* add badge for OpenSSF best practices ([26c01c8](http://github.com/abdes/asap/commit/26c01c8bcf98c6b47e6622dea91a6c6e10bc978c)) -- add CPM as preferred way of managing third party deps +* add CPM as preferred way of managing third party deps ([5a33f70](http://github.com/abdes/asap/commit/5a33f70a15a64c84f0a13b4286460f9df20459a5)) -- add tutorial videos +* add tutorial videos ([cb13248](http://github.com/abdes/asap/commit/cb13248244cddd0dc2c187893556fad7aa4f08b7)) -- fix thumbnail and links of project docs video +* fix thumbnail and links of project docs video ([1a6269e](http://github.com/abdes/asap/commit/1a6269eef8999504aba8105d4c446a93e41c988b)) -- how to report security vulnerabilities +* how to report security vulnerabilities ([46426e9](http://github.com/abdes/asap/commit/46426e9d44f3c4e8ee0b3fdd98e2ee56d13f8890)) -- improve the key features section +* improve the key features section ([79119ba](http://github.com/abdes/asap/commit/79119ba52f578a28dfdeb1ce59bba67c3fbcd3c1)) -- include build status badges for all branches +* include build status badges for all branches ([2b98ae1](http://github.com/abdes/asap/commit/2b98ae11ace8fa756c825686018a3a328ce27eca)) -- revamp the project README +* revamp the project README ([e72c4c3](http://github.com/abdes/asap/commit/e72c4c3288d565b34b137ab785abe90370052258)) -- rewrite the contributing section +* rewrite the contributing section ([c7e39c4](http://github.com/abdes/asap/commit/c7e39c4cfa6033aac42befe5ed994089e601b6a0)) -- update instructions for repo from template scenario +* update instructions for repo from template scenario ([1cafdb5](http://github.com/abdes/asap/commit/1cafdb57f86a4b61a736b3411791ae96ca684f33)) -- update project docs video +* update project docs video ([c7f79fc](http://github.com/abdes/asap/commit/c7f79fc64900cfa9ec3d2466300d1d32830b32f1)) ## [4.2.0](http://github.com/abdes/asap/compare/v4.1.8...v4.2.0) (2022-04-03) ### Features -- make ccache usable on all platforms +* make ccache usable on all platforms ([412730f](http://github.com/abdes/asap/commit/412730f86679d7ccd350cadf5649b7a489376cae)) ### Bug Fixes -- use only white-listed properties for interface library +* use only white-listed properties for interface library ([227de02](http://github.com/abdes/asap/commit/227de026878beb9dd9679d0cad12cf25bce16c4a)) ## [4.1.8](http://github.com/abdes/asap/compare/v4.1.7...v4.1.8) (2022-03-15) -- chore: use [CPM](https://github.com/cpm-cmake/CPM.cmake#adding-cpm) for +* chore: use [CPM](https://github.com/cpm-cmake/CPM.cmake#adding-cpm) for dependency management -- chore: use ccache to speedup build +* chore: use ccache to speedup build ## [4.1.7](http://github.com/abdes/asap/compare/v4.1.6...v4.1.7) (2022-03-06) @@ -170,9 +179,9 @@ docs: add last-updated-on timestamp ### Bug Fixes -- define asap_top_level_install as empty when project install should be skipped +* define asap_top_level_install as empty when project install should be skipped ([616deed](http://github.com/abdes/asap/commit/616deed7f2655cf6690135ed1914f7eec8053373)) -- use correct links for documentation +* use correct links for documentation ([486144c](http://github.com/abdes/asap/commit/486144c46222c22861b0a14f9dc002d148a31f24)), closes [#4](http://github.com/abdes/asap/issues/4) @@ -195,45 +204,45 @@ and streamline the generated targets. ### Bug Fixes -- always use top level build dir for output +* always use top level build dir for output ([1b01db2](http://github.com/abdes/asap/commit/1b01db2402bc52944646bcde3cf525315a4e0e1b)) -- doxygen and sphinx target conflict with modules +* doxygen and sphinx target conflict with modules ([02375ff](http://github.com/abdes/asap/commit/02375ff4a33e34a8e0cb9307ef4eb6de3271e945)) -- generate doc only if project is master +* generate doc only if project is master ([82190fa](http://github.com/abdes/asap/commit/82190fa6562f5e51dbbab660bcab8dc265e99a0b)) -- make doxygen targets sub-project friendly +* make doxygen targets sub-project friendly ([546fe73](http://github.com/abdes/asap/commit/546fe73ded53721dddbac311e9db41e4146b8ad2)) -- make gtest work again +* make gtest work again ([3ce658c](http://github.com/abdes/asap/commit/3ce658c5f1eb216a3286717e7f80827b96ff3b49)) -- make sphinx targets sub-project friendly +* make sphinx targets sub-project friendly ([024cc77](http://github.com/abdes/asap/commit/024cc77d17ed134ed5f3f4eea32226b07b05aad6)) -- only add clang-format/tidy targets if master project +* only add clang-format/tidy targets if master project ([060f082](http://github.com/abdes/asap/commit/060f082714e039eb4c2c2e198b5caed74690e8af)) -- only install files if requested to install +* only install files if requested to install ([9caaf9b](http://github.com/abdes/asap/commit/9caaf9b47e138be3f9845d6d58ebc21ff8dfa83b)) -- reorganize third_party modules for use of FetchContent +* reorganize third_party modules for use of FetchContent ([cc65bc2](http://github.com/abdes/asap/commit/cc65bc2219dbe38197107bae71252444994e118c)) -- use correct tagets for doc builds +* use correct tagets for doc builds ([559558e](http://github.com/abdes/asap/commit/559558e8eac3043eef19986cc2ae6d6dfd937be8)) -- use correct url for logo image +* use correct url for logo image ([96d1e01](http://github.com/abdes/asap/commit/96d1e01d971bd2f33faaebfc060082023f3a5209)) -- use correct url for master index page +* use correct url for master index page ([a56c327](http://github.com/abdes/asap/commit/a56c327ff3d7ab14d7a499fc4997279efd2647fe)) -- use lower case META_PROJECT_ID +* use lower case META_PROJECT_ID ([311e433](http://github.com/abdes/asap/commit/311e433e8698ff6385c2cda256bff83982596ed0)) -- wrong variable used for target name +* wrong variable used for target name ([829f351](http://github.com/abdes/asap/commit/829f351d22b384ddc060ae2df47ff9e801089dd2)) ## [4.1.1](http://github.com/abdes/asap/compare/v4.1.0...v4.1.1) (2022-02-18) -- docs: use submodule documentation deployment urls for inter-sphinx +* docs: use submodule documentation deployment urls for inter-sphinx configuration. using the local build directory will result in the deployed documentation to still be dependent on the build paths. ## [4.1.0](http://github.com/abdes/asap/compare/v4.0.2...v4.1.0) (2022-02-18) -- improvements and bug fixes in the documentation -- update GSL to 4.0.0 +* improvements and bug fixes in the documentation +* update GSL to 4.0.0 ## [4.0.2](http://github.com/abdes/asap/compare/v4.0.1...v4.0.2) (2022-02-17) @@ -242,22 +251,22 @@ refactor the docs for easier maintenance and use in forked projects. ### Bug Fixes -- contract api docs now in contract module +* contract api docs now in contract module ([d3366bd](http://github.com/abdes/asap/commit/d3366bd846d66486b2fcf98f36fd741452be8516)) -- keep `src` even when empty for doxygen not to complain +* keep `src` even when empty for doxygen not to complain ([be28f42](http://github.com/abdes/asap/commit/be28f429eddde8f258a08e84722e4fcaf975b384)) ## [4.0.1](http://github.com/abdes/asap/compare/v4.0.1...v4.0.0) (2022-02-17) -- update the GitHub action for windows build to 2022 +* update the GitHub action for windows build to 2022 ## [4.0.0](http://github.com/abdes/asap/compare/v3.1.2...v4.0.0) (2022-02-17) ### Features -- overload pattern for variant visitation on the fly +* overload pattern for variant visitation on the fly ([53ea7cc](http://github.com/abdes/asap/commit/53ea7cc74e89913cbf59eda2e30bd36c356e6acd)) -- refactor: trim the project to the bare +* refactor: trim the project to the bare minimum([8d48a56](https://github.com/abdes/asap/commit/8d48a56ef0db2359aa80b5e5b2854802dc6a45f0)) The intention from the asap base project is to be a template starter repo that @@ -271,159 +280,159 @@ refactor the docs for easier maintenance and use in forked projects. ### Bug Fixes -- use separate sphinx cache dir for each module +* use separate sphinx cache dir for each module ([03f36fc](http://github.com/abdes/asap/commit/03f36fc96c78c51b441feb9a7b9c70d19a2125c7)) ## [3.1.2](http://github.com/abdes/asap/compare/v3.1.1...v3.1.2) (2021-12-19) ### Features -- doxygen snippets from `test` or `examples` source directories +* doxygen snippets from `test` or `examples` source directories ([85b8000](http://github.com/abdes/asap/commit/85b8000e91dd105c0f90a62b1824957b68ce9c03)) ### Bug Fixes -- **doc:** wrong chapter title in logging module page +* **doc:** wrong chapter title in logging module page ([5966912](http://github.com/abdes/asap/commit/59669122d3ea8565878667e6f09b124bc7da1b99)) -- doxygen doc generation uses wrong module info +* doxygen doc generation uses wrong module info ([8833474](http://github.com/abdes/asap/commit/8833474402c523a3f2eda10b8927da46989f4bba)) -- need to hardcode `asap` when linking `common` +* need to hardcode `asap` when linking `common` ([e038a70](http://github.com/abdes/asap/commit/e038a702ce8727fa1a6c8b3a45cb4bb211281db5)) ## [3.1.1](http://github.com/abdes/asap/compare/v3.1.0...v3.1.1) (2021-12-19) ### Documentation -- minor tweaks to the sphinx config +* minor tweaks to the sphinx config ## [3.1.0](http://github.com/abdes/asap/compare/v3.0.0...v3.1.0) (2021-12-18) ### ⚠ BREAKING CHANGES -- The logging `Registry` is now implemented as a singleton class and therefore +* The logging `Registry` is now implemented as a singleton class and therefore it needs to be accessed via its instance() method. All other methods in its interface are not static anymore. -- Prefix the build options with `ASAP_` to make them unique and avoid clashing +* Prefix the build options with `ASAP_` to make them unique and avoid clashing with other projects that may use the generic `OPTION_xxx` names. Additionally, the build presets now always activate building of tests and examples except in release builds where examples are not built. -- The cmake option `OPTION_SELF_CONTAINED` is no longer relevant as we believe +* The cmake option `OPTION_SELF_CONTAINED` is no longer relevant as we believe that 3rd party dependencies should be installed using their own projects. In the worst case scenario, they should be explicitly added as install instructions to the project in a visible and documented way. ### Features -- add support for .editorconfig +* add support for .editorconfig ([5a7a689](http://github.com/abdes/asap/commit/5a7a6892f7c05798e79c6f81e9eef3b0a6256ca1)) -- provide a way to distinguish between debug and release builds via preprocessor +* provide a way to distinguish between debug and release builds via preprocessor define ([bbd84a2](http://github.com/abdes/asap/commit/bbd84a2c32c9833f79b442e202b647f93946b105)) ### Bug Fixes -- adjust doc target names to work in renamed projects +* adjust doc target names to work in renamed projects ([60acc65](http://github.com/abdes/asap/commit/60acc65fcc8d529a69f3617d792376be3e54b6ce)) -- cmake option was placed in the wrong command +* cmake option was placed in the wrong command ([b634b15](http://github.com/abdes/asap/commit/b634b153db975a8bc8715e82f7fafdc214504cfa)) -- clean the logging API implementation +* clean the logging API implementation ([25535c7](http://github.com/abdes/asap/commit/25535c76c0586d53f7c6c55db250a251f0c5390b)) ## [3.0.0](http://github.com/abdes/asap/compare/v2.0.1...v3.0.0) (2021-12-08) ### ⚠ BREAKING CHANGES -- The project requires C++17 as it is widely available in compilers now. Logical +* The project requires C++17 as it is widely available in compilers now. Logical traits such as conjunction, disjunction and negation are available from the standard include. -- major redesign of the cmake build system, many macros and functions have been +* major redesign of the cmake build system, many macros and functions have been changed and the build system overall has been simplified. -- `catch2` has been replaced by Google Test/Mock, which provides more features, +* `catch2` has been replaced by Google Test/Mock, which provides more features, less compiler warnings and is more popular. Catch2 or any other framework can still be easily added to an `asap` based project. -- `hedely` was removed from `common` and was replaced by a much lighter new file +* `hedely` was removed from `common` and was replaced by a much lighter new file `compilers.h`. -- `nowide` was removed from `common` and will be replaced by the standalone +* `nowide` was removed from `common` and will be replaced by the standalone boost nowide library when needed. -- `filesystem` footprint is too large to be included by default in `asap` +* `filesystem` footprint is too large to be included by default in `asap` starter project. It will be provided separately and a mechanism to easily add it into an `asap` based project will be implemented in a future update. ### Features -- add gsl library +* add gsl library ([9b982f1](http://github.com/abdes/asap/commit/9b982f17aeb9362619cf871ed9bbedb65344ab43)) -- add support for CMake presets +* add support for CMake presets ([bdcfa4d](http://github.com/abdes/asap/commit/bdcfa4d6a0cfffe0026af39b635c6dcd4e61e3a8)) -- add contract checking api (assertions) +* add contract checking api (assertions) ([c691446](http://github.com/abdes/asap/commit/c691446fd18242840e62529f1aabdaf8480b7ec6)) -- convert git submodule to local module +* convert git submodule to local module ([4e32e8a](http://github.com/abdes/asap/commit/4e32e8a6d1152413af12c7013ee759eca5e2d51d)) -- redesign cmake build system +* redesign cmake build system ([31ce14a](http://github.com/abdes/asap/commit/31ce14a301ac2e725b7760581e696f089225b161)) -- remove filesystem submodule +* remove filesystem submodule ([e2089ae](http://github.com/abdes/asap/commit/e2089ae7707c1448c78db23db2f53cbfab461599)) -- remove logical traits backport +* remove logical traits backport ([5ed0fe6](http://github.com/abdes/asap/commit/5ed0fe6e9e03399e640221a285f87a1a8a015cd1)) -- significantly enhance the documentation, both doxygen based for APIs and +* significantly enhance the documentation, both doxygen based for APIs and sphinx based for the project docs ### Bug Fixes -- configure compilation database for clangd when using cmake presets +* configure compilation database for clangd when using cmake presets ([7493c24](http://github.com/abdes/asap/commit/7493c240ce97396040d9a7bd09cb32ed56ea2340)) -- hardcode `asap` in places where we should not use the custom project name +* hardcode `asap` in places where we should not use the custom project name ([7f81298](http://github.com/abdes/asap/commit/7f81298b31e5a235bf4bce4778525a2e4594befa)) -- match Clang and Apple Clang for compiler options +* match Clang and Apple Clang for compiler options ([7e1e123](http://github.com/abdes/asap/commit/7e1e12317b62099bb58ce5dd4adfdbf1a759ad03)) -- convert unit testing to gtest/gmock +* convert unit testing to gtest/gmock ([b99c8d0](http://github.com/abdes/asap/commit/b99c8d0a315bb8200ca9cec93c9d5f64880c9271)) ## [2.0.1](http://github.com/abdes/asap/compare/v2.0.0...v2.0.1) (2021-11-06) ### Bug Fixes -- "-Wreserved-identifier" only if not APPLE +* "-Wreserved-identifier" only if not APPLE ([05fac12](http://github.com/abdes/asap/commit/05fac12d37978c6651c299e6ad1cc64dfed88fa0)) -- cmake require c++ 14 in all modules +* cmake require c++ 14 in all modules ([f05c9a6](http://github.com/abdes/asap/commit/f05c9a63e97dbcbef3e7d8188a04e719e2247d62)) -- use lower-case name for sphinx +* use lower-case name for sphinx ([f3005b5](http://github.com/abdes/asap/commit/f3005b5bd4055b16a57cdcb3af70a2f32b1c5809)) ## [2.0.0](http://github.com/abdes/asap/compare/v1.0.0...v2.0.0) (2021-11-06) ### Features -- Cleanup the code to remove most compiler and linter warnings. -- Refactor cmake build files to have robust support for sanitizers and linters. -- Rationalize the compiler options to strictly stick to those options that won't +* Cleanup the code to remove most compiler and linter warnings. +* Refactor cmake build files to have robust support for sanitizers and linters. +* Rationalize the compiler options to strictly stick to those options that won't conflict with application decisions. -- Enhanced the documentation +* Enhanced the documentation ### To be continued -- Refactoring of cmake build files. -- Remove additional warnings from code. -- Documentation. +* Refactoring of cmake build files. +* Remove additional warnings from code. +* Documentation. ### ⚠ BREAKING CHANGES -- logging is in a new module: asap::logging. +* logging is in a new module: asap::logging. Many modules would want to only get the basic common functionality without pulling extra 3rd party dependencies such as spdlog, fmt etc... For this reason, the logging functionality is taken out of the common submodule and moved to logging submodule. -- move logging functionality to separate module +* move logging functionality to separate module ([46f4dd9](http://github.com/abdes/asap/commit/46f4dd96edb1148e0772a1539b989fd80f3821e4)) ## 1.0.0 (2021-11-03) ### Features -- add support for Conventional Commits and auto Changelog +* add support for Conventional Commits and auto Changelog ([7b827fa](http://github.com/abdes/asap/commit/7b827fab2ae28ba903c69ab5acdf249cb3e55d85)) -- replace cmake compiler detection with hedley +* replace cmake compiler detection with hedley ([8bf0a3d](http://github.com/abdes/asap/commit/8bf0a3d53fcdba65497491cbd63c1dcffcba8467)) diff --git a/CMakeLists.txt b/CMakeLists.txt index 5acf5bc..49a480e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,7 +40,7 @@ set(META_AUTHOR_DOMAIN "https://github.com/abdes/asap") set(META_AUTHOR_MAINTAINER "Abdessattar Sassi") set(META_VERSION_MAJOR "4") set(META_VERSION_MINOR "4") -set(META_VERSION_PATCH "0") +set(META_VERSION_PATCH "1") set(META_VERSION_REVISION "${GIT_REV}") set(META_VERSION "${META_VERSION_MAJOR}.${META_VERSION_MINOR}.${META_VERSION_PATCH}") set(META_NAME_VERSION "${META_PROJECT_NAME} v${META_VERSION} (${META_VERSION_REVISION})")