Merge pull request #5 from aminya/install

Author: aminya

.github/workflows/ci.yml

@@ -98,6 +98,7 @@ jobs:
           vcpkg: true
           ccache: true
           clangtidy: true
+          make: true
 
           cppcheck: true
 
@@ -132,6 +133,9 @@ jobs:
 
           gcovr -j ${{env.nproc}} --delete --root ./ --print-summary --xml-pretty --xml coverage.xml ./build --gcov-executable '${{ matrix.gcov_executable }}'
 
+          # test installation
+          make test_install
+
       - name: Windows - Test and coverage
         if: runner.os == 'Windows'
         run: |
@@ -140,6 +144,8 @@ jobs:
             cd ./build/my_header_lib/test; ctest -C ${{matrix.build_type}} --output-on-failure; cd ../../../
             cd ./build/my_lib/test; ctest -C ${{matrix.build_type}} --output-on-failure; cd ../../../      
           '
+          # test installation
+          make test_install
 
       - name: Perform CodeQL Analysis
         if: ${{ contains(matrix.os, 'ubuntu') && contains(matrix.compiler, 'llvm') }}

CMakeLists.txt

@@ -81,6 +81,8 @@ add_subdirectory(./my_exe)
 add_subdirectory(./my_lib)
 add_subdirectory(./my_header_lib)
 
+# the variables set using CACHE STRING "" are passed to package_project
+
 # Package the project
 package_project(
   TARGETS

Makefile

@@ -24,6 +24,9 @@ test_release:
 	(cd build/my_header_lib/test && ctest -C RelWithDebInfo --output-on-failure)
 	(cd build/my_lib/test && ctest -C RelWithDebInfo --output-on-failure)
 
+test_install:
+	cmake --install ./build --prefix ./install
+
 docs:
 	cmake ./ -B ./build -G "Ninja Multi-Config" -DCMAKE_BUILD_TYPE:STRING=Debug -DFEATURE_DOCS:BOOL=ON -DFEATURE_TESTS:BOOL=OFF
 	cmake --build ./build --target doxygen-docs --config Debug

my_exe/CMakeLists.txt

@@ -3,11 +3,11 @@ target_link_libraries(my_exe PRIVATE project_options project_warnings) # link pr
 
 # Includes
 # because my_exe includes are private, it uses absolute paths.
-set(my_exe_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include")
+set(my_exe_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include" CACHE STRING "")
 target_include_directories(my_exe PRIVATE "${my_exe_INCLUDE_DIR}")
 
 # Find dependencies:
-set(my_exe_DEPENDENCIES_CONFIGURED fmt)
+set(my_exe_DEPENDENCIES_CONFIGURED fmt CACHE STRING "")
 
 foreach(DEPENDENCY ${my_exe_DEPENDENCIES_CONFIGURED})
   find_package(${DEPENDENCY} CONFIG REQUIRED)

my_header_lib/CMakeLists.txt

@@ -2,13 +2,13 @@ add_library(my_header_lib INTERFACE)
 target_link_libraries(my_header_lib INTERFACE project_options project_warnings) # link project_options/warnings
 
 # Includes
-set(my_header_lib_INCLUDE_DIR "./include") # must be relative paths
+set(my_header_lib_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include" CACHE STRING "") # must be relative paths
 target_include_directories(
-  my_header_lib INTERFACE "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/${my_header_lib_INCLUDE_DIR}>"
+  my_header_lib INTERFACE "$<BUILD_INTERFACE:${my_header_lib_INCLUDE_DIR}>"
                           "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>")
 
 # Find dependencies:
-set(my_header_lib_DEPENDENCIES_CONFIGURED fmt)
+set(my_header_lib_DEPENDENCIES_CONFIGURED fmt CACHE STRING "")
 
 foreach(DEPENDENCY ${my_header_lib_DEPENDENCIES_CONFIGURED})
   find_package(${DEPENDENCY} CONFIG REQUIRED)

my_lib/CMakeLists.txt

@@ -2,12 +2,16 @@ add_library(my_lib "./src/my_lib/lib.cpp")
 target_link_libraries(my_lib PRIVATE project_options project_warnings) # link project_options/warnings
 
 # Includes
-set(my_lib_INCLUDE_DIR "include") # must be relative paths
-target_include_directories(my_lib PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/${my_lib_INCLUDE_DIR}>"
+set(my_lib_INCLUDE_DIR
+    "${CMAKE_CURRENT_SOURCE_DIR}/include"
+    CACHE STRING "")
+target_include_directories(my_lib PUBLIC "$<BUILD_INTERFACE:${my_lib_INCLUDE_DIR}>"
                                          "$<INSTALL_INTERFACE:./${CMAKE_INSTALL_INCLUDEDIR}>")
 
 # Find dependencies:
-set(my_lib_DEPENDENCIES_CONFIGURED fmt)
+set(my_lib_DEPENDENCIES_CONFIGURED
+    fmt
+    CACHE STRING "")
 
 foreach(DEPENDENCY ${my_lib_DEPENDENCIES_CONFIGURED})
   find_package(${DEPENDENCY} CONFIG REQUIRED)