cmake packaging

Author: scivision

.github/workflows/ci.yml

@@ -57,8 +57,8 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         upload_url: ${{ github.event.release.upload_url }}
-        asset_path: build/package/nc4fortran-${{ steps.get_version.outputs.VERSION }}-Linux.zip
-        asset_name:  nc4fortran-${{ steps.get_version.outputs.VERSION }}-Linux.zip
+        asset_path: build/package/nc4fortran-${{ steps.get_version.outputs.VERSION }}-Linux.tar.gz
+        asset_name:  nc4fortran-${{ steps.get_version.outputs.VERSION }}-Linux.tar.gz
         asset_content_type: application/zip
 
 
@@ -84,7 +84,6 @@ jobs:
       working-directory: build
 
 
-
   mac:
     needs: linux
     runs-on: macos-latest
@@ -129,6 +128,6 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         upload_url: ${{ github.event.release.upload_url }}
-        asset_path: build/nc4fortran-${{ steps.get_version.outputs.VERSION }}-Darwin.zip
-        asset_name:  nc4fortran-${{ steps.get_version.outputs.VERSION }}-Darwin.zip
+        asset_path: build/nc4fortran-${{ steps.get_version.outputs.VERSION }}-Darwin.tar.gz
+        asset_name:  nc4fortran-${{ steps.get_version.outputs.VERSION }}-Darwin.tar.gz
         asset_content_type: application/zip

CMakeLists.txt

@@ -56,6 +56,7 @@ if(${PROJECT_NAME}_BUILD_TESTING)
   add_subdirectory(src/tests)
 endif()
 
+include(cmake/pkgconf.cmake)
 include(cmake/install.cmake)
 
 include(FeatureSummary)

Examples/CMakeLists.txt

@@ -7,19 +7,15 @@ include(CTest)
 
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/../cmake/Modules)
 
-find_package(nc4fortran CONFIG)
+# --- find external libraries
 
-if(NOT nc4fortran_FOUND)
-  message(FATAL_ERROR "could not find nc4fortran")
-endif()
+find_package(NetCDF COMPONENTS Fortran REQUIRED)
 
-include(${nc4fortran_DIR}/nc4fortranTargets.cmake)
+# --- Find our library
 
-if(NOT TARGET nc4fortran::nc4fortran)
-  message(FATAL_ERROR "nc4fortran not found.")
-endif()
+set(CMAKE_FIND_PACKAGE_PREFER_CONFIG true)
 
-find_package(NetCDF COMPONENTS Fortran REQUIRED)
+find_package(nc4fortran REQUIRED PATHS ${PROJECT_SOURCE_DIR}/../build)
 
 # --- Fortran interface for examples
 add_library(fortran_interface fortran_interface.f90)

cmake/Config.cmake.in

@@ -0,0 +1,5 @@
+@PACKAGE_INIT@
+
+include("${CMAKE_CURRENT_LIST_DIR}/@[email protected]")
+
+check_required_components(@PROJECT_NAME@)

cmake/install.cmake

@@ -2,12 +2,12 @@
 
 include(CMakePackageConfigHelpers)
 
-configure_package_config_file(${CMAKE_CURRENT_LIST_DIR}/${PROJECT_NAME}Config.cmake.in
-  ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
+configure_package_config_file(${CMAKE_CURRENT_LIST_DIR}/Config.cmake.in
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Config.cmake
   INSTALL_DESTINATION lib)
 
 write_basic_package_version_file(
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}ConfigVersion.cmake
   VERSION ${${PROJECT_NAME}_VERSION}
   COMPATIBILITY SameMinorVersion
 )
@@ -19,14 +19,23 @@ install(EXPORT ${PROJECT_NAME}Targets
    )
 
 install(FILES
-  ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
-  ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Config.cmake
+  ${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}ConfigVersion.cmake
   DESTINATION lib/cmake/${PROJECT_NAME})
 
+export(EXPORT ${PROJECT_NAME}Targets
+  FILE "${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}Targets.cmake"
+  NAMESPACE ${PROJECT_NAME}::
+)
+
 # --- CPack
 
-set(CPACK_GENERATOR ZIP)
-set(CPACK_SOURCE_GENERATOR ZIP)
+set(_fmt TGZ)
+if(WIN32)
+  set(_fmt ZIP)
+endif()
+set(CPACK_GENERATOR ${_fmt})
+set(CPACK_SOURCE_GENERATOR ${_fmt})
 set(CPACK_PACKAGE_VENDOR "Michael Hirsch")
 set(CPACK_PACKAGE_CONTACT "Michael Hirsch")
 set(CPACK_DEBIAN_PACKAGE_DEPENDS "libnetcdff-dev")

cmake/nc4fortranConfig.cmake.in

@@ -7,3 +7,8 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS on)
 if(NOT dev)
   set(EP_UPDATE_DISCONNECTED true)
 endif()
+
+# --- auto-ignore build directory
+if(NOT EXISTS ${PROJECT_BINARY_DIR}/.gitignore)
+  file(WRITE ${PROJECT_BINARY_DIR}/.gitignore "*")
+endif()

cmake/options.cmake

@@ -0,0 +1,8 @@
+# --- generate pkg-config .pc
+
+set(pc_requires "netcdf-fortran")
+
+set(pc_filename ${PROJECT_NAME}.pc)
+configure_file(${CMAKE_CURRENT_LIST_DIR}/pkgconf.pc.in ${pc_filename} @ONLY)
+
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${pc_filename} DESTINATION lib/pkgconfig)

cmake/pkgconf.cmake

@@ -0,0 +1,13 @@
+prefix="@CMAKE_INSTALL_PREFIX@"
+exec_prefix="${prefix}"
+libdir="${prefix}/lib"
+includedir="${prefix}/include"
+
+Name: @PROJECT_NAME@
+Description: @CMAKE_PROJECT_DESCRIPTION@
+URL: @CMAKE_PROJECT_HOMEPAGE_URL@
+Version: @PROJECT_VERSION@
+Requires: @pc_requires@
+Cflags: -I"${includedir}"
+Libs: -L"${libdir}" -l@PROJECT_NAME@
+Libs.private: -L"${libdir}" -l@PROJECT_NAME@