refactor: follow CMake Starter version 2.0.0 style and configuration (#…

…242)

* ci: rename steps in workflows

Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>

* build: install package version file under `cmake` dir

Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>

* build: create package version file with `ARCH_INDEPENDENT` option

Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>

* style: format CMake files

Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>

* docs: remove module description in `Assertion.cmake` file

Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>

---------

Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>

.github/workflows/build.yaml

@@ -9,7 +9,7 @@ jobs:
     name: Build Project
     runs-on: ubuntu-22.04
     steps:
-      - name: Checkout
+      - name: Checkout Project
         uses: actions/checkout@v4.2.0
 
       - name: Configure Project
@@ -20,7 +20,7 @@ jobs:
       - name: Install Project
         run: cmake --install build --prefix install
 
-      - name: Upload Project as Artifact
+      - name: Upload Project
         uses: actions/upload-artifact@v4.4.0
         with:
           name: Assertion

.github/workflows/test.yaml

@@ -9,7 +9,7 @@ jobs:
     name: Test Project
     runs-on: ubuntu-22.04
     steps:
-      - name: Checkout
+      - name: Checkout Project
         uses: actions/checkout@v4.2.0
 
       - name: Configure Project

CMakeLists.txt

@@ -8,8 +8,7 @@ project(
   LANGUAGES NONE)
 
 option(ASSERTION_ENABLE_TESTS "Enable test targets.")
-option(ASSERTION_ENABLE_INSTALL "Enable install targets."
-  ${PROJECT_IS_TOP_LEVEL})
+option(ASSERTION_ENABLE_INSTALL "Enable install targets." "${PROJECT_IS_TOP_LEVEL}")
 
 include(cmake/Assertion.cmake)
 
@@ -25,12 +24,12 @@ endif()
 
 if(ASSERTION_ENABLE_INSTALL)
   include(CMakePackageConfigHelpers)
-  write_basic_package_version_file(
-    AssertionConfigVersion.cmake COMPATIBILITY SameMajorVersion)
+  write_basic_package_version_file(cmake/AssertionConfigVersion.cmake
+    COMPATIBILITY SameMajorVersion ARCH_INDEPENDENT)
 
   install(
     FILES cmake/Assertion.cmake
       cmake/AssertionConfig.cmake
-      ${CMAKE_CURRENT_BINARY_DIR}/AssertionConfigVersion.cmake
+      ${CMAKE_CURRENT_BINARY_DIR}/cmake/AssertionConfigVersion.cmake
     DESTINATION lib/cmake/Assertion)
 endif()

cmake/Assertion.cmake

@@ -20,18 +20,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-# This module contains a collection of assertion functions and other utilities
-# for testing CMake code.
-#
-# The main feature of this module is the `assert` function for asserting the
-# given condition in the style of CMake's `if` function. If the assertion fails,
-# it will throw a fatal error message with information about the context of the
-# asserted condition.
-#
-# This module also supports CMake test creation using the
-# `add_cmake_script_test` function. This function will create a new test that
-# processes the given file in script mode.
-
 # This variable contains the version of the included `Assertion.cmake` module.
 set(ASSERTION_VERSION 2.0.0)