Merge branch 'main' into feature/improve-hfc-FIND_PACKAGE_ARGS-handling

Author: daminetreg

.github/PULL_REQUEST_TEMPLATE/HFC-RELEASING.md

@@ -1,10 +1,9 @@
 ---
-name: [HFC] Release
-about: Checklist to make a release
+name: "[HFC] Release"
+about: "Checklist to make a release"
 title: "[HFC][RELEASE] v0.0."
-labels: ''
-assignees: ''
-
+labels: ""
+assignees: ""
 ---
 
 # How to make a release ?

.github/workflows/ci.yml

@@ -1,12 +1,11 @@
 name: build 
 
-# This workflow is triggered on pushes to the repository.
+# This workflow is triggered on PRs ony
 on:
-  push:
-    branches:
-      - main
-      - develop
-  pull_request:
+  pull_request_target:
+
+permissions:
+  contents: read
 
 env:
   GHA_HFC_TOOLS_DIR_CACHE_KEY: 20241128
@@ -49,11 +48,15 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-hfc-project-cache-
 
-      - name: checkout
+      # Checkout the project to the correct location
+      # note: having two distinct paths here depending on wether or not we're looking at a PR or push to main
+      #
+      # This is necessary because we use the pull_request_target which requires a fully specified :ref: config
+      - name: checkout pull request
         uses: actions/checkout@v4
-        with:
-          # Relative path under $GITHUB_WORKSPACE to place the repository
+        with:          
           path: './hfc_project'
+          ref: ${{ github.event.pull_request.head.sha }}
 
       - name: tipi builds project 
         run: |

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+How to contribute to Hermetic FetchContent
+==========================================
+
+
+### Did you find a bug?
+
+- Please ensure the bug was not already reported by searching in the existing issues
+
+- If you're unable to find an existing issue, please open a new issue. Be sure to include a *title and a clear description* and as much relevant information as possible. If you can, please provide us with a minimal sample to help us reproduce the issue.
+
+
+### Did you write a patch that fixes a bug?
+
+- Please open a new Github pull request with the patch
+
+- Ensure the PR description clearly describes the problem and solution
+
+- Ensure that the test suite passes. We are fond of contributions that add tests ensuring no regression will happen in the future :heart:

README.md

@@ -146,6 +146,10 @@ You can run the HermeticFetchContent test suite this way:
   * `HFC_PROJECT_HFC_BASEDIR` to use a common "HFC base dir" (which will contain the dependency install trees)
   * `HERMETIC_FETCHCONTENT_TOOLS_DIR` if you have one, avoid rebuilding `goldilock` too frequently, by default a `${CMAKE_BINARY_DIR}/.hfc_tools/` directory will be created
 
+## Contributing
+
+Please refer to [Contributing](./CONTRIBUTING.md) for details.
+
 ## Authors
 
 Authored with love, blood and tears in Zürich, Switzerland by team **[tipi.build](https://tipi.build)**.

cmake/modules/hfc_autotools_register_content_build.cmake

@@ -118,12 +118,19 @@ function(hfc_autotools_register_content_build content_name)
 
   endif()
 
-  if(HERMETIC_FETCHCONTENT_REMOVE_BUILD_DIR_AFTER_INSTALL)
+
+  if(HFC_V1_REMOVE_BUILD_DIR_AFTER_INSTALL)
     string(APPEND install_command " && ${CMAKE_COMMAND} -E rm -rf ${FN_ARG_PROJECT_BINARY_DIR} ")
   endif()
 
-  if(HERMETIC_FETCHCONTENT_REMOVE_SOURCE_DIR_AFTER_INSTALL)
+  if(HFC_V1_REMOVE_SOURCE_DIR_AFTER_INSTALL)
     string(APPEND install_command " && ${CMAKE_COMMAND} -E rm -rf ${FN_ARG_PROJECT_SOURCE_DIR} ")
+
+    hfc_compute_subbuild_path(${content_name} subbuild_path
+      SOURCE_DIR "${FN_ARG_PROJECT_SOURCE_DIR}"
+    )
+
+    string(APPEND install_command " && ${CMAKE_COMMAND} -E rm -rf ${subbuild_path} ")
   endif()
 
   #hfc_get_command_string_in_cleared_env("${build_command}" build_command)

cmake/modules/hfc_cmake_register_content_build.cmake

@@ -100,7 +100,7 @@ function(hfc_cmake_register_content_build content_name)
 
   endif()
 
-  if ("${FN_ARG_CUSTOM_INSTALL_TARGETS}" STREQUAL "")
+  if (NOT FN_ARG_BUILD_TARGETS AND (NOT FN_ARG_CUSTOM_INSTALL_TARGETS))
     list(APPEND install_commands_list "${CMAKE_COMMAND} --install .")
   endif()
 
@@ -142,11 +142,17 @@ function(hfc_cmake_register_content_build content_name)
 
   endif()
 
-  if(HERMETIC_FETCHCONTENT_REMOVE_BUILD_DIR_AFTER_INSTALL)
+  if(HFC_V1_REMOVE_BUILD_DIR_AFTER_INSTALL)
     string(APPEND install_command " && ${CMAKE_COMMAND} -E rm -rf ${FN_ARG_PROJECT_BINARY_DIR} ")
   endif()
-  if(HERMETIC_FETCHCONTENT_REMOVE_SOURCE_DIR_AFTER_INSTALL)
+  if(HFC_V1_REMOVE_SOURCE_DIR_AFTER_INSTALL)
     string(APPEND install_command " && ${CMAKE_COMMAND} -E rm -rf ${FN_ARG_PROJECT_SOURCE_DIR} ")
+
+    hfc_compute_subbuild_path(${content_name} subbuild_path
+      SOURCE_DIR "${FN_ARG_PROJECT_SOURCE_DIR}"
+    )
+
+    string(APPEND install_command " && ${CMAKE_COMMAND} -E rm -rf ${subbuild_path} ")
   endif()
 
   if(DEFINED FN_ARG_PROJECT_SOURCE_SUBDIR)

cmake/modules/hfc_initialize.cmake

@@ -307,8 +307,8 @@ function(hfc_initialize HFC_ROOT_DIR)
 
     # Note : We don't set the following defaults on purpose as unset it will be evaluated OFF
     #        This allows also overriding with a pure scope variable and not CACHE
-    # set(HERMETIC_FETCHCONTENT_REMOVE_BUILD_DIR_AFTER_INSTALL OFF CACHE BOOL "By default save space by removing build")
-    # set(HERMETIC_FETCHCONTENT_REMOVE_SOURCE_DIR_AFTER_INSTALL OFF CACHE BOOL "By default save space by removing sources after install")
+    # set(HFC_V1_REMOVE_BUILD_DIR_AFTER_INSTALL OFF CACHE BOOL "By default save space by removing build")
+    # set(HFC_V1_REMOVE_SOURCE_DIR_AFTER_INSTALL OFF CACHE BOOL "By default save space by removing sources after install")
 
     set_property(GLOBAL PROPERTY HERMETIC_FETCHCONTENT_INITIALIZED ON)
     set(HERMETIC_FETCHCONTENT_ROOT_DIR "${HFC_ROOT_DIR}" CACHE INTERNAL "Root directory of Hermetic_FetchContent")

cmake/modules/hfc_make_available_single.cmake

@@ -68,6 +68,11 @@ function(hfc_make_available_single content_name build_at_configure_time)
     HERMETIC_DISCOVER_TARGETS_FILE_PATTERN
 
     HERMETIC_BUILD_AT_CONFIGURE_TIME
+
+    # Disambiguate parameter parsing with all supported
+    # fetchcontent-details
+    SBOM_LICENSE
+    SBOM_SUPPLIER
   )
 
   set(multi_value_params

cmake/modules/hfc_populate_project.cmake

@@ -98,6 +98,7 @@ function(hfc_populate_project_declare content_name)
       GIT_REPOSITORY 
       GIT_TAG
       GIT_SUBMODULES
+      GIT_SHALLOW
       SOURCE_DIR 
       BUILD_IN_SOURCE_TREE
       SOURCE_SUBDIR
@@ -262,6 +263,10 @@ function(hfc_populate_project_declare content_name)
       list(APPEND populate_args "PATCH_COMMAND" "${FN_ARG_PATCH_COMMAND}")
       list(APPEND populate_args "UPDATE_DISCONNECTED" "1")  # avoid issues with repeated builds, which would "repatch"
     endif()
+
+    if(FN_ARG_GIT_SHALLOW) 
+      list(APPEND populate_args "GIT_SHALLOW" ${FN_ARG_GIT_SHALLOW})
+    endif()
 
     # we used to fix issues that could occur if the sources are missing but the stamp file were still around
     # we now explictely trust the stamps file, this allow better debugging for developers

cmake/modules/hfc_sbom.cmake

@@ -189,9 +189,9 @@ cmake_policy(SET CMP0007 NEW)
 function(file)
     list(GET ARGN 0 file_OP)
     list(GET ARGN 1 param_2)
-    list(SUBLIST ARGN 2 -1 remaining_args)
 
     if((\"\${file_OP}\" STREQUAL \"APPEND\") AND (\"\${param_2}\" STREQUAL \"\${spdx_in_file_dest}\"))
+        list(SUBLIST ARGN 2 -1 remaining_args)
         _file(APPEND \"\${spdx_in_file_tmp}\" \${remaining_args})
     elseif(\"\${file_OP}\" STREQUAL \"READ\") 
         _file(\${ARGN})
@@ -220,7 +220,10 @@ message(STATUS \" - generating SBOM\")
 
 set(SBOM_VERIFICATION_CODE \"\")
 configure_file(\"\${spdx_in_file_tmp}\" \"${output_destination_path}.\${tmp_suffix}\")
-file(COPY_FILE \"${output_destination_path}.\${tmp_suffix}\" \"${output_destination_path}\" ONLY_IF_DIFFERENT)
+file(TOUCH \"${output_destination_path}.lock\")
+file(LOCK \"${output_destination_path}.lock\")
+  file(COPY_FILE \"${output_destination_path}.\${tmp_suffix}\" \"${output_destination_path}\" ONLY_IF_DIFFERENT)
+file(LOCK \"${output_destination_path}.lock\" RELEASE)
 
 # clean up temp files
 message(STATUS \"Cleaning up temp files\")