Update dependencies and enhance CI configuration

sean-parent · sean-parent · commit fa53f4244de0 · 2026-05-20T14:08:34.000-07:00
- Updated doctest dependency version from 2.4.12 to 2.5.2 in cpp-library.cmake.
- Improved README.md with additional setup instructions for CPM.cmake and local usage examples.
- Refined CI workflow configuration in ci.yml and ci.yml.in to utilize defined action variables for better maintainability.
- Updated Doxygen theme dependency version from 2.4.1 to 2.4.2 in cpp-library-docs.cmake.
- Added new graph options in Doxyfile.in to control documentation output.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,6 +14,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      # [DEPENDENCY] https://github.com/actions/checkout/releases
       - uses: actions/checkout@v6
 
       - name: Run dependency mapping tests
@@ -27,6 +28,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      # [DEPENDENCY] https://github.com/actions/checkout/releases
       - uses: actions/checkout@v6
 
       - name: Download CPM.cmake
@@ -136,6 +138,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      # [DEPENDENCY] https://github.com/actions/checkout/releases
       - uses: actions/checkout@v6
 
       - name: Check README examples
diff --git a/README.md b/README.md
@@ -92,10 +92,17 @@ cmake --build --preset=init
 
 ## Manual Setup
 
-If you prefer to set up your project manually, or need to integrate cpp-library into an existing project, follow these steps.
+If you prefer to set up your project manually or need to integrate the cpp-library into an existing project, follow these steps.
 
 ### Usage
 
+Install [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake):
+
+```bash
+mkdir -p cmake
+curl -L -o cmake/CPM.cmake "https://github.com/cpm-cmake/CPM.cmake/releases/latest/download/get_cpm.cmake"
+```
+
 Use `CPMAddPackage` to fetch cpp-library directly in your `CMakeLists.txt`:
 
 ```cmake
@@ -130,8 +137,6 @@ cpp_library_setup(
 )
 ```
 
-**Requirements:** CMake 3.24+, C++17+ compiler (GCC 7+, Clang 5+, MSVC 2017+, or Apple Clang 9+)
-
 ### Consuming Libraries Built with cpp-library
 
 #### Using CPMAddPackage (recommended)
@@ -525,6 +530,20 @@ The dependency provider (CMake 3.24+) tracks `find_package()` and `CPMAddPackage
 
 ## Development
 
+To use a local copy of cpp-library:
+
+```
+CPMAddPackage(
+    NAME cpp-library
+     SOURCE_DIR "${CMAKE_SOURCE_DIR}/../cpp-library"
+)
+```
+
+To use cpp-library from a specific commit:
+```
+CPMAddPackage("gh:stlab/cpp-library#65dbed9fff9a0331355bd51dc1e8156262390154")
+```
+
 To run cpp-library's unit tests for dependency mapping and installation:
 
 ```bash
diff --git a/cmake/cpp-library-ci.cmake b/cmake/cpp-library-ci.cmake
@@ -9,6 +9,22 @@
 # - Postcondition: .github/workflows/ci.yml created from template if not present
 # - With force_init: overwrites existing workflow file
 function(_cpp_library_setup_ci PACKAGE_NAME force_init)
+    # GitHub Actions refs (versions and source links) - update here to bump CI deps
+    # [DEPENDENCY] https://github.com/actions/checkout/releases
+    set(CI_ACTION_CHECKOUT "actions/checkout@v6")
+    # [DEPENDENCY] https://github.com/ilammy/msvc-dev-cmd/releases
+    # @1.13.0
+    set(CI_ACTION_MSVC_DEV_CMD "ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756")
+    # [DEPENDENCY] https://github.com/ssciwr/doxygen-install/releases
+    # @2.0.1
+    set(CI_ACTION_DOXYGEN_INSTALL "ssciwr/doxygen-install@329d88f5a303066a5bd006db7516b1925b86350e")
+    # [DEPENDENCY] https://github.com/actions/configure-pages/releases
+    set(CI_ACTION_CONFIGURE_PAGES "actions/configure-pages@v6")
+    # [DEPENDENCY] https://github.com/actions/upload-pages-artifact/releases
+    set(CI_ACTION_UPLOAD_PAGES_ARTIFACT "actions/upload-pages-artifact@v5")
+    # [DEPENDENCY] https://github.com/actions/deploy-pages/releases
+    set(CI_ACTION_DEPLOY_PAGES "actions/deploy-pages@v5")
+
     set(ci_template "${CPP_LIBRARY_ROOT}/templates/.github/workflows/ci.yml.in")
     set(ci_dest "${CMAKE_CURRENT_SOURCE_DIR}/.github/workflows/ci.yml")
     
diff --git a/cmake/cpp-library-docs.cmake b/cmake/cpp-library-docs.cmake
@@ -26,7 +26,8 @@ function(_cpp_library_setup_docs)
     # Download doxygen-awesome-css theme via CPM
     # https://github.com/jothepro/doxygen-awesome-css
     CPMAddPackage(
-        URI gh:jothepro/doxygen-awesome-css@2.4.1
+        # [DEPENDENCY] https://github.com/jothepro/doxygen-awesome-css/releases
+        URI gh:jothepro/doxygen-awesome-css@2.4.2
         DOWNLOAD_ONLY YES
     )
 
diff --git a/cpp-library.cmake b/cpp-library.cmake
@@ -289,7 +289,8 @@ function(cpp_library_setup)
     # This must happen during normal configuration (not deferred) because CPMAddPackage uses add_subdirectory
     if(BUILD_TESTING AND (ARG_TESTS OR ARG_EXAMPLES))
         if(NOT TARGET doctest::doctest)
-            CPMAddPackage("gh:doctest/doctest@2.4.12")
+            # [DEPENDENCY] https://github.com/doctest/doctest/releases
+            CPMAddPackage("gh:doctest/doctest@2.5.2")
         endif()
     endif()
     
diff --git a/templates/.github/workflows/ci.yml.in b/templates/.github/workflows/ci.yml.in
@@ -1,5 +1,6 @@
 # Auto-generated from cpp-library (https://github.com/stlab/cpp-library)
 # Do not edit this file directly - it will be overwritten when templates are regenerated
+# Dependency versions are defined in cmake/cpp-library-ci.cmake (with source links)
 
 name: CI
 
@@ -34,7 +35,9 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: @CI_ACTION_CHECKOUT@
+      - if: ${{ startsWith(matrix.config.os, 'windows') }}
+        uses: @CI_ACTION_MSVC_DEV_CMD@
 
       - name: Configure CMake
         run: cmake --preset=test
@@ -97,7 +100,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: @CI_ACTION_CHECKOUT@
 
       - name: Configure CMake with clang-tidy
         run: cmake --preset=clang-tidy
@@ -117,11 +120,10 @@ jobs:
       contents: read
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: @CI_ACTION_CHECKOUT@
 
-      # ssciwr/doxygen-install@1.6.4
       - name: Install Doxygen
-        uses: ssciwr/doxygen-install@501e53b879da7648ab392ee226f5b90e42148449
+        uses: @CI_ACTION_DOXYGEN_INSTALL@
 
       - name: Configure CMake
         run: cmake --preset=docs
@@ -130,13 +132,13 @@ jobs:
         run: cmake --build --preset=docs
 
       - name: Setup Pages
-        uses: actions/configure-pages@v5
+        uses: @CI_ACTION_CONFIGURE_PAGES@
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v4
+        uses: @CI_ACTION_UPLOAD_PAGES_ARTIFACT@
         with:
           path: build/docs/html
 
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: @CI_ACTION_DEPLOY_PAGES@
diff --git a/templates/Doxyfile.in b/templates/Doxyfile.in
@@ -25,3 +25,10 @@ DISTRIBUTE_GROUP_DOC    = YES
 MAX_INITIALIZER_LINES   = 0
 MULTILINE_CPP_IS_BRIEF  = YES
 WARN_AS_ERROR           = YES
+INCLUDE_GRAPH           = NO
+INCLUDED_BY_GRAPH       = NO
+DIRECTORY_GRAPH         = NO
+CLASS_GRAPH             = NO
+COLLABORATION_GRAPH     = NO
+GRAPHICAL_HIERARCHY     = NO
+GROUP_GRAPHS            = NO

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,8 @@ function(_cpp_library_setup_docs)`
`26`	`26`	`# Download doxygen-awesome-css theme via CPM`
`27`	`27`	`# https://github.com/jothepro/doxygen-awesome-css`
`28`	`28`	`CPMAddPackage(`
`29`		`- URI gh:jothepro/doxygen-awesome-css@2.4.1`
	`29`	`+ # [DEPENDENCY] https://github.com/jothepro/doxygen-awesome-css/releases`
	`30`	`+ URI gh:jothepro/doxygen-awesome-css@2.4.2`
`30`	`31`	`DOWNLOAD_ONLY YES`
`31`	`32`	`)`
`32`	`33`