Refactor project layout: build presets, CMake modules, and script organization

Author: Pierre-Luc Gagné

.gitignore

@@ -1,6 +1,4 @@
 build/
-build-coverage/
-build_clang/
 .env
 compile_commands.json
 *.o

CMakeLists.txt

@@ -14,115 +14,12 @@ if(EXISTS "${CMAKE_SOURCE_DIR}/.githooks")
     )
 endif()
 
-# Set C++23 standard
-set(CMAKE_CXX_STANDARD 23)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
-set(CMAKE_CXX_EXTENSIONS OFF)
-
-# Export compile commands for IDEs
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
-
-# Set default build type if not specified
-if(NOT CMAKE_BUILD_TYPE)
-    set(CMAKE_BUILD_TYPE Release)
-endif()
-
-# Build options
-option(BUILD_EXAMPLES "Build examples" ON)
-option(ENABLE_COVERAGE "Enable code coverage" OFF)
-option(SKIP_DOCKER_MANAGEMENT "Skip Docker container lifecycle in CTest (use when DB is externally provided, e.g. CI)" OFF)
-option(BUILD_INTEGRATION_TESTS "Build integration tests" ON)
-
-# Compiler options
-if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
-    add_compile_options(
-        -Wall
-        -Wextra
-        -Wpedantic
-        -Werror
-    )
-elseif(MSVC)
-    add_compile_options(
-        /W4       # High warning level
-        /WX       # Warnings as errors
-        /permissive-  # Strict standards conformance
-        /Zc:preprocessor # Enable standards-conforming preprocessor (__VA_OPT__)
-    )
-endif()
-
-# Coverage flags
-if(ENABLE_COVERAGE)
-    if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
-        add_compile_options(--coverage)
-        add_link_options(--coverage)
-        message(STATUS "Coverage enabled with --coverage flags")
-    else()
-        message(WARNING "Coverage is not supported with ${CMAKE_CXX_COMPILER_ID}")
-    endif()
-endif()
-
-# Include FetchContent for dependency management
-include(FetchContent)
-
 # Make local CMake helper modules available early (needed by fetched deps).
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 
-# MySQL client library
-if(WIN32)
-    # On Windows, search common MySQL Server installation paths.
-    # Override by passing -DMYSQL_ROOT_DIR=<path> to cmake.
-    set(MYSQL_ROOT_DIR "" CACHE PATH "MySQL installation root (e.g. C:/Program Files/MySQL/MySQL Server 8.0)")
-    if(NOT MYSQL_ROOT_DIR)
-        file(GLOB _mysql_dirs "C:/Program Files/MySQL/MySQL Server *")
-        if(_mysql_dirs)
-            list(SORT _mysql_dirs ORDER DESCENDING)
-            list(GET _mysql_dirs 0 MYSQL_ROOT_DIR)
-            set(MYSQL_ROOT_DIR "${MYSQL_ROOT_DIR}" CACHE PATH "" FORCE)
-        else()
-            message(FATAL_ERROR "MySQL not found. Set -DMYSQL_ROOT_DIR=<path> to the MySQL installation directory.")
-        endif()
-    endif()
-
-    find_path(MYSQL_INCLUDE_DIR mysql.h PATHS "${MYSQL_ROOT_DIR}/include" NO_DEFAULT_PATH REQUIRED)
-    find_library(MYSQL_LIBRARY libmysql PATHS "${MYSQL_ROOT_DIR}/lib" NO_DEFAULT_PATH REQUIRED)
-    set(MYSQL_INCLUDE_DIRS "${MYSQL_INCLUDE_DIR}")
-    set(MYSQL_LIBRARIES "${MYSQL_LIBRARY}")
-    message(STATUS "MySQL found at: ${MYSQL_ROOT_DIR}")
-else()
-    find_package(PkgConfig REQUIRED)
-    pkg_check_modules(MYSQL REQUIRED mysqlclient)
-endif()
-
-# Note: Boost.PFR is header-only and doesn't have a standard CMake config package yet,
-# so we fetch it directly without find_package. Once Boost.PFR is officially integrated
-# into Boost's CMake build system, we can use: find_package(Boost REQUIRED COMPONENTS pfr CONFIG)
-
-# Boost.PFR (header-only, for compile-time reflection without macros)
-# We only need the headers; FetchContent_Populate avoids processing Boost.PFR's own
-# CMake build system, whose tests require Boost::core which is unavailable here.
-FetchContent_Declare(
-    boost_pfr_headers
-    GIT_REPOSITORY https://github.com/boostorg/pfr.git
-    GIT_TAG master
-    GIT_SHALLOW TRUE
-)
-# CMP0169 OLD: suppress the single-arg FetchContent_Populate deprecation warning.
-# This is intentional — we want headers only, not add_subdirectory behaviour.
-cmake_policy(PUSH)
-if(POLICY CMP0169)
-    cmake_policy(SET CMP0169 OLD)
-endif()
-FetchContent_Populate(boost_pfr_headers)
-cmake_policy(POP)
-
-# Create Boost.PFR target if not already provided by Boost.PFR's own CMake
-if(NOT TARGET Boost::pfr)
-    add_library(Boost::pfr INTERFACE IMPORTED)
-    set_target_properties(Boost::pfr PROPERTIES
-        INTERFACE_INCLUDE_DIRECTORIES "${boost_pfr_headers_SOURCE_DIR}/include"
-        INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${boost_pfr_headers_SOURCE_DIR}/include"
-    )
-endif()
+include(ProjectOptions)
+include(CompilerOptions)
+include(Dependencies)
 
 # Auto-create .env from .env.example in tests/integration if missing
 if(NOT EXISTS "${CMAKE_SOURCE_DIR}/tests/integration/.env")

CMakePresets.json

@@ -10,7 +10,7 @@
       "name": "default",
       "displayName": "Default (Release)",
       "generator": "Ninja",
-      "binaryDir": "${sourceDir}/build",
+      "binaryDir": "${sourceDir}/build/default",
       "cacheVariables": {
         "CMAKE_POLICY_DEFAULT_CMP0175": "OLD",
         "CMAKE_BUILD_TYPE": "Release",
@@ -22,7 +22,7 @@
       "name": "debug",
       "displayName": "Debug",
       "generator": "Ninja",
-      "binaryDir": "${sourceDir}/build",
+      "binaryDir": "${sourceDir}/build/debug",
       "cacheVariables": {
         "CMAKE_POLICY_DEFAULT_CMP0175": "OLD",
         "CMAKE_BUILD_TYPE": "Debug",
@@ -34,7 +34,7 @@
       "name": "release",
       "displayName": "Release",
       "generator": "Ninja",
-      "binaryDir": "${sourceDir}/build",
+      "binaryDir": "${sourceDir}/build/release",
       "cacheVariables": {
         "CMAKE_POLICY_DEFAULT_CMP0175": "OLD",
         "CMAKE_BUILD_TYPE": "Release",
@@ -46,7 +46,7 @@
       "name": "coverage",
       "displayName": "Coverage",
       "generator": "Ninja",
-      "binaryDir": "${sourceDir}/build-coverage",
+      "binaryDir": "${sourceDir}/build/coverage",
       "cacheVariables": {
         "CMAKE_POLICY_DEFAULT_CMP0175": "OLD",
         "CMAKE_BUILD_TYPE": "Debug",
@@ -59,7 +59,7 @@
       "name": "ci",
       "displayName": "CI (externally-managed DB)",
       "generator": "Ninja",
-      "binaryDir": "${sourceDir}/build-ci",
+      "binaryDir": "${sourceDir}/build/ci",
       "cacheVariables": {
         "CMAKE_POLICY_DEFAULT_CMP0175": "OLD",
         "CMAKE_BUILD_TYPE": "Release",

README.md

@@ -94,7 +94,7 @@ git clone https://github.com/DisciplinedSoftware/DSMySQL.git
 cd DSMySQL
 
 cmake --preset release
-cmake --build build -j$(nproc)
+cmake --build build/release -j$(nproc)
 ctest --preset release
 ```
 
@@ -112,14 +112,23 @@ ctest --preset release
 ```bash
 # Unit tests only, skip integration tests
 cmake --preset release -DBUILD_INTEGRATION_TESTS=OFF
-cmake --build build -j$(nproc)
+cmake --build build/release -j$(nproc)
 ctest --preset release
 
 # Debug build
 cmake --preset debug
-cmake --build build -j$(nproc)
+cmake --build build/debug -j$(nproc)
 ```
 
+## Scripts Layout
+
+Project automation scripts are grouped by purpose:
+
+- `scripts/ci/act-ci.sh` — run `tests-gcc` job locally with `act`
+- `scripts/ci/act-ci-full.sh` — run Linux CI jobs locally in sequence with `act`
+- `scripts/release/release.sh` — bump version, update changelog, commit, and tag
+- `scripts/release/act-release.sh` — dry-run release workflow locally with `act`
+
 ## Using as a Dependency
 
 Since DSMySQL is header-only, integrate it with CMake FetchContent:
@@ -141,8 +150,8 @@ Optional install/package flow:
 
 ```bash
 cmake --preset release -DDSMYSQL_ENABLE_INSTALL=ON
-cmake --build build -j$(nproc)
-cmake --install build --prefix /usr/local
+cmake --build build/release -j$(nproc)
+cmake --install build/release --prefix /usr/local
 ```
 
 ```cmake
@@ -260,9 +269,9 @@ Integration tests connect to a real MySQL 8.0 instance managed via Docker Compos
 ctest --preset release
 
 # Manual container management
-cmake --build build --target docker_integration_up
+cmake --build build/release --target docker_integration_up
 ctest --preset release -R tests_integration_ds_mysql
-cmake --build build --target docker_integration_down
+cmake --build build/release --target docker_integration_down
 ```
 
 See [docs/INTEGRATION_TESTS.md](docs/INTEGRATION_TESTS.md) for full details.

cmake/CompilerOptions.cmake

@@ -0,0 +1,29 @@
+# Shared compiler warnings and instrumentation flags.
+
+# Compiler options
+if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+    add_compile_options(
+        -Wall
+        -Wextra
+        -Wpedantic
+        -Werror
+    )
+elseif(MSVC)
+    add_compile_options(
+        /W4       # High warning level
+        /WX       # Warnings as errors
+        /permissive-  # Strict standards conformance
+        /Zc:preprocessor # Enable standards-conforming preprocessor (__VA_OPT__)
+    )
+endif()
+
+# Coverage flags
+if(ENABLE_COVERAGE)
+    if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+        add_compile_options(--coverage)
+        add_link_options(--coverage)
+        message(STATUS "Coverage enabled with --coverage flags")
+    else()
+        message(WARNING "Coverage is not supported with ${CMAKE_CXX_COMPILER_ID}")
+    endif()
+endif()

cmake/Dependencies.cmake

@@ -0,0 +1,60 @@
+# Shared third-party dependency resolution.
+
+include(FetchContent)
+
+# MySQL client library
+if(WIN32)
+    # On Windows, search common MySQL Server installation paths.
+    # Override by passing -DMYSQL_ROOT_DIR=<path> to cmake.
+    set(MYSQL_ROOT_DIR "" CACHE PATH "MySQL installation root (e.g. C:/Program Files/MySQL/MySQL Server 8.0)")
+    if(NOT MYSQL_ROOT_DIR)
+        file(GLOB _mysql_dirs "C:/Program Files/MySQL/MySQL Server *")
+        if(_mysql_dirs)
+            list(SORT _mysql_dirs ORDER DESCENDING)
+            list(GET _mysql_dirs 0 MYSQL_ROOT_DIR)
+            set(MYSQL_ROOT_DIR "${MYSQL_ROOT_DIR}" CACHE PATH "" FORCE)
+        else()
+            message(FATAL_ERROR "MySQL not found. Set -DMYSQL_ROOT_DIR=<path> to the MySQL installation directory.")
+        endif()
+    endif()
+
+    find_path(MYSQL_INCLUDE_DIR mysql.h PATHS "${MYSQL_ROOT_DIR}/include" NO_DEFAULT_PATH REQUIRED)
+    find_library(MYSQL_LIBRARY libmysql PATHS "${MYSQL_ROOT_DIR}/lib" NO_DEFAULT_PATH REQUIRED)
+    set(MYSQL_INCLUDE_DIRS "${MYSQL_INCLUDE_DIR}")
+    set(MYSQL_LIBRARIES "${MYSQL_LIBRARY}")
+    message(STATUS "MySQL found at: ${MYSQL_ROOT_DIR}")
+else()
+    find_package(PkgConfig REQUIRED)
+    pkg_check_modules(MYSQL REQUIRED mysqlclient)
+endif()
+
+# Note: Boost.PFR is header-only and doesn't have a standard CMake config package yet,
+# so we fetch it directly without find_package. Once Boost.PFR is officially integrated
+# into Boost's CMake build system, we can use: find_package(Boost REQUIRED COMPONENTS pfr CONFIG)
+
+# Boost.PFR (header-only, for compile-time reflection without macros)
+# We only need the headers; FetchContent_Populate avoids processing Boost.PFR's own
+# CMake build system, whose tests require Boost::core which is unavailable here.
+FetchContent_Declare(
+    boost_pfr_headers
+    GIT_REPOSITORY https://github.com/boostorg/pfr.git
+    GIT_TAG master
+    GIT_SHALLOW TRUE
+)
+# CMP0169 OLD: suppress the single-arg FetchContent_Populate deprecation warning.
+# This is intentional — we want headers only, not add_subdirectory behaviour.
+cmake_policy(PUSH)
+if(POLICY CMP0169)
+    cmake_policy(SET CMP0169 OLD)
+endif()
+FetchContent_Populate(boost_pfr_headers)
+cmake_policy(POP)
+
+# Create Boost.PFR target if not already provided by Boost.PFR's own CMake
+if(NOT TARGET Boost::pfr)
+    add_library(Boost::pfr INTERFACE IMPORTED)
+    set_target_properties(Boost::pfr PROPERTIES
+        INTERFACE_INCLUDE_DIRECTORIES "${boost_pfr_headers_SOURCE_DIR}/include"
+        INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${boost_pfr_headers_SOURCE_DIR}/include"
+    )
+endif()

cmake/ProjectOptions.cmake

@@ -0,0 +1,20 @@
+# Shared project-level build options and defaults.
+
+# Set C++23 standard
+set(CMAKE_CXX_STANDARD 23)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+# Export compile commands for IDEs
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+# Set default build type if not specified
+if(NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Release)
+endif()
+
+# Build options
+option(BUILD_EXAMPLES "Build examples" ON)
+option(ENABLE_COVERAGE "Enable code coverage" OFF)
+option(SKIP_DOCKER_MANAGEMENT "Skip Docker container lifecycle in CTest (use when DB is externally provided, e.g. CI)" OFF)
+option(BUILD_INTEGRATION_TESTS "Build integration tests" ON)

docs/BUILD.md

@@ -12,7 +12,7 @@
 
 ```bash
 cmake --preset release
-cmake --build build -j$(nproc)
+cmake --build build/release -j$(nproc)
 ctest --preset release
 ```
 
@@ -30,8 +30,8 @@ DSMySQL/
 ## Configure + Build Manually
 
 ```bash
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=g++-15
-cmake --build build -j$(nproc)
+cmake -S . -B build/release -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=g++-15
+cmake --build build/release -j$(nproc)
 ```
 
 ## Build Options
@@ -55,16 +55,16 @@ ctest --preset release
 
 # Skip integration tests
 cmake --preset release -DBUILD_INTEGRATION_TESTS=OFF
-cmake --build build -j$(nproc)
+cmake --build build/release -j$(nproc)
 ctest --preset release
 ```
 
 ## Code Coverage
 
 ```bash
 cmake --preset coverage
-cmake --build build-coverage -j$(nproc)
+cmake --build build/coverage -j$(nproc)
 ctest --preset coverage
-./scripts/generate_coverage.sh build-coverage
-# Report: build-coverage/html/index.html
+./scripts/generate_coverage.sh build/coverage
+# Report: build/coverage/html/index.html
 ```