Getting close to v1.

sean-parent · sean-parent · commit 99294353d906 · 2025-08-21T16:20:06.000-07:00
diff --git a/cmake/cpp-library-ci.cmake b/cmake/cpp-library-ci.cmake
@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: BSL-1.0
+#
+# cpp-library-ci.cmake - CI setup functionality
+
+function(_cpp_library_setup_ci)
+    set(options
+        CI_DEPLOY_DOCS
+    )
+    set(oneValueArgs
+        NAME
+        VERSION
+        DESCRIPTION
+    )
+    set(multiValueArgs
+        CI_PLATFORMS
+        CI_COMPILERS
+    )
+    
+    cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+    
+    # Set defaults
+    if(NOT ARG_CI_PLATFORMS)
+        set(ARG_CI_PLATFORMS "ubuntu-latest" "macos-latest" "windows-latest")
+    endif()
+    if(NOT ARG_CI_COMPILERS)
+        set(ARG_CI_COMPILERS "gcc" "clang" "msvc")
+    endif()
+    
+    # Only generate CI files if they don't exist
+    if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/.github/workflows/ci.yml")
+        # Create .github/workflows directory
+        file(MAKE_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/.github/workflows")
+        
+        # Determine template source
+        if(DEFINED CPP_LIBRARY_CI_TEMPLATE)
+            # Embedded template (packaged version)
+            file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/cpp-library-ci.yml.in" "${CPP_LIBRARY_CI_TEMPLATE}")
+            set(TEMPLATE_FILE "${CMAKE_CURRENT_BINARY_DIR}/cpp-library-ci.yml.in")
+        else()
+            # External template file (development version)
+            set(TEMPLATE_FILE "${CPP_LIBRARY_ROOT}/templates/.github/workflows/ci.yml.in")
+        endif()
+        
+        # Configure template variables
+        set(PROJECT_NAME "${ARG_NAME}")
+        set(PROJECT_VERSION "${ARG_VERSION}")
+        set(PROJECT_DESCRIPTION "${ARG_DESCRIPTION}")
+        if(ARG_CI_DEPLOY_DOCS)
+            set(ENABLE_DOCS_DEPLOYMENT "true")
+        else()
+            set(ENABLE_DOCS_DEPLOYMENT "false")
+        endif()
+        
+        configure_file(
+            "${TEMPLATE_FILE}"
+            "${CMAKE_CURRENT_SOURCE_DIR}/.github/workflows/ci.yml"
+            @ONLY
+        )
+        
+        message(STATUS "Generated .github/workflows/ci.yml for ${ARG_NAME}")
+    endif()
+    
+endfunction()
diff --git a/cmake/cpp-library-setup.cmake b/cmake/cpp-library-setup.cmake
@@ -10,6 +10,7 @@ function(_cpp_library_setup_core)
         NAMESPACE
         HEADER_DIR
         REQUIRES_CPP_VERSION
+        TOP_LEVEL
     )
     set(multiValueArgs
         HEADERS
@@ -45,7 +46,7 @@ function(_cpp_library_setup_core)
     endif()
     
     # Only set up full installation when building as top-level project
-    if(PROJECT_IS_TOP_LEVEL)
+    if(ARG_TOP_LEVEL)
         include(GNUInstallDirs)
         include(CMakePackageConfigHelpers)
         
diff --git a/cpp-library.cmake b/cpp-library.cmake
@@ -16,13 +16,15 @@ include("${CPP_LIBRARY_ROOT}/cmake/cpp-library-setup.cmake")
 include("${CPP_LIBRARY_ROOT}/cmake/cpp-library-testing.cmake")  
 include("${CPP_LIBRARY_ROOT}/cmake/cpp-library-docs.cmake")
 include("${CPP_LIBRARY_ROOT}/cmake/cpp-library-presets.cmake")
+include("${CPP_LIBRARY_ROOT}/cmake/cpp-library-ci.cmake")
 
 # Main entry point function - users call this to set up their library
 function(cpp_library_setup)
     # Parse arguments
     set(options 
         CUSTOM_INSTALL          # Skip default installation
         NO_PRESETS             # Skip CMakePresets.json generation
+        NO_CI                  # Skip CI generation (CI enabled by default)
     )
     set(oneValueArgs
         NAME                    # Project name (e.g., "stlab-enum-ops")
@@ -64,7 +66,7 @@ function(cpp_library_setup)
         set(ARG_REQUIRES_CPP_VERSION 17)
     endif()
     
-    # Call component setup functions
+    # Create the basic library target (always done)
     _cpp_library_setup_core(
         NAME "${ARG_NAME}"
         VERSION "${ARG_VERSION}" 
@@ -73,21 +75,30 @@ function(cpp_library_setup)
         HEADERS "${ARG_HEADERS}"
         HEADER_DIR "${ARG_HEADER_DIR}"
         REQUIRES_CPP_VERSION "${ARG_REQUIRES_CPP_VERSION}"
+        TOP_LEVEL "${PROJECT_IS_TOP_LEVEL}"
     )
     
-    if(NOT ARG_NO_PRESETS AND PROJECT_IS_TOP_LEVEL)
+    # Only setup development infrastructure when building as top-level project
+    if(NOT PROJECT_IS_TOP_LEVEL)
+        return()  # Early return for lightweight consumer mode
+    endif()
+    
+    # Generate CMakePresets.json (unless disabled)
+    if(NOT ARG_NO_PRESETS)
         _cpp_library_generate_presets()
     endif()
     
-    if(BUILD_TESTING AND PROJECT_IS_TOP_LEVEL AND ARG_TESTS)
+    # Setup testing (if tests are specified)
+    if(BUILD_TESTING AND ARG_TESTS)
         _cpp_library_setup_testing(
             NAME "${ARG_NAME}"
             NAMESPACE "${ARG_NAMESPACE}" 
             TESTS "${ARG_TESTS}"
         )
     endif()
     
-    if(BUILD_DOCS AND PROJECT_IS_TOP_LEVEL)
+    # Setup documentation (always for top-level)
+    if(BUILD_DOCS)
         _cpp_library_setup_docs(
             NAME "${ARG_NAME}"
             VERSION "${ARG_VERSION}"
@@ -96,8 +107,18 @@ function(cpp_library_setup)
         )
     endif()
     
-    # Build examples if specified
-    if(PROJECT_IS_TOP_LEVEL AND ARG_EXAMPLES)
+    # Setup CI (unless disabled)
+    if(NOT ARG_NO_CI)
+        _cpp_library_setup_ci(
+            NAME "${ARG_NAME}"
+            VERSION "${ARG_VERSION}"
+            DESCRIPTION "${ARG_DESCRIPTION}"
+            CI_DEPLOY_DOCS YES  # Always enable docs deployment
+        )
+    endif()
+    
+    # Build examples if specified  
+    if(ARG_EXAMPLES)
         foreach(example IN LISTS ARG_EXAMPLES)
             if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/example/${example}.cpp")
                 string(REPLACE "${ARG_NAMESPACE}-" "" CLEAN_NAME "${ARG_NAME}")
diff --git a/dist/cpp-library.cmake b/dist/cpp-library.cmake
@@ -84,6 +84,92 @@ HTML_EXTRA_FILES       = @AWESOME_CSS_PATH@/doxygen-awesome-darkmode-toggle.js \
 HTML_HEADER            = 
 USE_MDFILE_AS_MAINPAGE = README.md
 ")
+set(CPP_LIBRARY_CI_TEMPLATE "name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        compiler: [gcc, clang, msvc]
+        exclude:
+          - os: ubuntu-latest
+            compiler: msvc
+          - os: macos-latest
+            compiler: msvc
+          - os: macos-latest
+            compiler: gcc
+          - os: windows-latest
+            compiler: gcc
+          - os: windows-latest
+            compiler: clang
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup Ninja
+      uses: ashutoshvarma/setup-ninja@master
+
+    - name: Setup GCC
+      if: matrix.compiler == 'gcc'
+      uses: egor-tensin/setup-gcc@v1
+      with:
+        version: latest
+
+    - name: Setup Clang
+      if: matrix.compiler == 'clang' && matrix.os == 'ubuntu-latest'
+      uses: egor-tensin/setup-clang@v1
+      with:
+        version: latest
+
+    - name: Setup MSVC
+      if: matrix.compiler == 'msvc'
+      uses: ilammy/msvc-dev-cmd@v1
+
+    - name: Configure CMake
+      run: cmake --preset=test
+
+    - name: Build
+      run: cmake --build --preset=test
+
+    - name: Test
+      run: ctest --preset=test
+
+  docs:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup Ninja
+      uses: ashutoshvarma/setup-ninja@master
+      
+    - name: Install Doxygen
+      run: sudo apt-get update && sudo apt-get install -y doxygen graphviz
+    
+    - name: Configure CMake
+      run: cmake --preset=docs
+    
+    - name: Build Documentation
+      run: cmake --build --preset=docs
+    
+    - name: Deploy to GitHub Pages
+      if: success() && '@ENABLE_DOCS_DEPLOYMENT@' == 'true'
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./build/docs/html
+        destination_dir: @PROJECT_NAME@
+")
 
 # === cpp-library-setup.cmake ===
 function(_cpp_library_setup_core)
@@ -339,13 +425,77 @@ function(_cpp_library_generate_presets)
 endfunction()
 
 
+# === cpp-library-ci.cmake ===
+function(_cpp_library_setup_ci)
+    set(options
+        CI_DEPLOY_DOCS
+    )
+    set(oneValueArgs
+        NAME
+        VERSION
+        DESCRIPTION
+    )
+    set(multiValueArgs
+        CI_PLATFORMS
+        CI_COMPILERS
+    )
+    
+    cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+    
+    # Set defaults
+    if(NOT ARG_CI_PLATFORMS)
+        set(ARG_CI_PLATFORMS "ubuntu-latest" "macos-latest" "windows-latest")
+    endif()
+    if(NOT ARG_CI_COMPILERS)
+        set(ARG_CI_COMPILERS "gcc" "clang" "msvc")
+    endif()
+    
+    # Only generate CI files if they don't exist
+    if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/.github/workflows/ci.yml")
+        # Create .github/workflows directory
+        file(MAKE_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/.github/workflows")
+        
+        # Determine template source
+        if(DEFINED CPP_LIBRARY_CI_TEMPLATE)
+            # Embedded template (packaged version)
+            file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/cpp-library-ci.yml.in" "${CPP_LIBRARY_CI_TEMPLATE}")
+            set(TEMPLATE_FILE "${CMAKE_CURRENT_BINARY_DIR}/cpp-library-ci.yml.in")
+        else()
+            # External template file (development version)
+            set(TEMPLATE_FILE "${CPP_LIBRARY_ROOT}/templates/.github/workflows/ci.yml.in")
+        endif()
+        
+        # Configure template variables
+        set(PROJECT_NAME "${ARG_NAME}")
+        set(PROJECT_VERSION "${ARG_VERSION}")
+        set(PROJECT_DESCRIPTION "${ARG_DESCRIPTION}")
+        if(ARG_CI_DEPLOY_DOCS)
+            set(ENABLE_DOCS_DEPLOYMENT "true")
+        else()
+            set(ENABLE_DOCS_DEPLOYMENT "false")
+        endif()
+        
+        configure_file(
+            "${TEMPLATE_FILE}"
+            "${CMAKE_CURRENT_SOURCE_DIR}/.github/workflows/ci.yml"
+            @ONLY
+        )
+        
+        message(STATUS "Generated .github/workflows/ci.yml for ${ARG_NAME}")
+    endif()
+    
+endfunction()
+
+
 # === Main cpp_library_setup function ===
 # Main entry point function - users call this to set up their library
 function(cpp_library_setup)
     # Parse arguments
     set(options 
         CUSTOM_INSTALL          # Skip default installation
         NO_PRESETS             # Skip CMakePresets.json generation
+        ENABLE_CI              # Generate CI files
+        CI_DEPLOY_DOCS         # Enable docs deployment in CI
     )
     set(oneValueArgs
         NAME                    # Project name (e.g., "stlab-enum-ops")
@@ -361,6 +511,8 @@ function(cpp_library_setup)
         TESTS                  # Test executables to build  
         DOCS_EXCLUDE_SYMBOLS   # Symbols to exclude from docs
         ADDITIONAL_DEPS        # Extra CPM dependencies
+        CI_PLATFORMS           # CI platforms (default: ubuntu-latest, macos-latest, windows-latest)
+        CI_COMPILERS           # CI compilers (default: gcc, clang, msvc)
     )
     
     cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
@@ -419,6 +571,17 @@ function(cpp_library_setup)
         )
     endif()
     
+    if(ARG_ENABLE_CI AND PROJECT_IS_TOP_LEVEL)
+        _cpp_library_setup_ci(
+            NAME "${ARG_NAME}"
+            VERSION "${ARG_VERSION}"
+            DESCRIPTION "${ARG_DESCRIPTION}"
+            CI_PLATFORMS "${ARG_CI_PLATFORMS}"
+            CI_COMPILERS "${ARG_CI_COMPILERS}"
+            CI_DEPLOY_DOCS "${ARG_CI_DEPLOY_DOCS}"
+        )
+    endif()
+    
     # Build examples if specified
     if(PROJECT_IS_TOP_LEVEL AND ARG_EXAMPLES)
         foreach(example IN LISTS ARG_EXAMPLES)
diff --git a/package.cmake b/package.cmake
diff --git a/templates/.github/workflows/ci.yml.in b/templates/.github/workflows/ci.yml.in
