Checkpoint

Author: sean-parent

.github/workflows/ci.yml

@@ -5,6 +5,8 @@ on:
     branches: [ main, develop ]
   pull_request:
     branches: [ main ]
+  release:
+    types: [published]
 
 jobs:
   test:
@@ -66,7 +68,7 @@ jobs:
 
   docs:
     runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    if: github.event_name == 'release' && github.event.action == 'published'
     permissions:
       id-token: write
       pages: write

CMakePresets.json

@@ -31,18 +31,26 @@
       "displayName": "Documentation Configuration",
       "description": "Configuration for building documentation",
       "binaryDir": "${sourceDir}/build/docs",
-      "inherits": "test",
+      "generator": "Ninja",
       "cacheVariables": {
-        "BUILD_DOCS": "ON"
+        "CMAKE_BUILD_TYPE": "Release",
+        "BUILD_TESTING": "OFF",
+        "BUILD_DOCS": "ON",
+        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
+        "CMAKE_CXX_EXTENSIONS": "OFF"
       }
     },
     {
       "name": "clang-tidy",
       "displayName": "Clang-Tidy Configuration",
       "description": "Configuration for running clang-tidy static analysis",
       "binaryDir": "${sourceDir}/build/clang-tidy",
-      "inherits": "test",
+      "generator": "Ninja",
       "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "BUILD_TESTING": "ON",
+        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
+        "CMAKE_CXX_EXTENSIONS": "OFF",
         "CMAKE_CXX_CLANG_TIDY": "clang-tidy"
       }
     },
@@ -51,8 +59,12 @@
       "displayName": "Initialize Templates",
       "description": "Force regeneration of template files (CMakePresets.json, CI, etc.)",
       "binaryDir": "${sourceDir}/build/init",
-      "inherits": "test",
+      "generator": "Ninja",
       "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "BUILD_TESTING": "OFF",
+        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
+        "CMAKE_CXX_EXTENSIONS": "OFF",
         "CPP_LIBRARY_FORCE_INIT": "ON"
       }
     }

examples/enum_ops_example.cpp

@@ -1,3 +1,7 @@
+#define DOCTEST_CONFIG_IMPLEMENT
+#include <doctest/doctest.h> // DOCTEST_CONFIG_IMPLEMENT
+
+/// [EXAMPLE]
 #include <stlab/enum_ops.hpp>
 
 #include <iostream>
@@ -21,3 +25,6 @@ int main() {
     bool has_preview = (x & views::preview) == views::preview;
     std::cout << has_text << " " << has_preview << "\n";
 }
+/// [EXAMPLE]
+
+TEST_CASE("Example: common use cases") { CHECK_NOTHROW(main()); }

include/stlab/enum_ops.hpp

@@ -52,7 +52,8 @@
     \section Example Example
 
     The following is an example of code that will compile:
-    \include enum_ops_example.cpp
+
+    \snippet enum_ops_example.cpp EXAMPLE
 
     The following is contains an example of code that will not compile
     since the typesafe operators have not been defined.