Merge branch 'main' into toolchain

.devcontainer/Dockerfile

@@ -0,0 +1,17 @@
+FROM mcr.microsoft.com/devcontainers/cpp:1-ubuntu-22.04
+
+USER vscode
+
+# Install latest cmake
+RUN wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | gpg --dearmor - | sudo tee /usr/share/keyrings/kitware-archive-keyring.gpg >/dev/null
+RUN echo 'deb [signed-by=/usr/share/keyrings/kitware-archive-keyring.gpg] https://apt.kitware.com/ubuntu/ jammy main' | sudo tee /etc/apt/sources.list.d/kitware.list >/dev/null
+RUN sudo apt-get update && sudo apt-get install -y cmake
+
+# Install pre-commit
+RUN sudo apt-get install -y python3-pip && pip3 install pre-commit
+
+# Avoid ASAN Stalling
+# See: https://github.com/google/sanitizers/issues/1614
+# Alternative is to update to above clang-18 and gcc-13.2
+# Maybe crashing codespace???
+RUN sudo sysctl -w vm.mmap_rnd_bits=28

.devcontainer/devcontainer.json

@@ -0,0 +1,18 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/cpp
+
+{
+	"name": "Beman Project Generic Devcontainer",
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+	"postCreateCommand": "bash .devcontainer/postcreate.sh",
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-vscode.cpptools",
+				"ms-vscode.cmake-tools"
+			]
+		}
+	}
+}

.devcontainer/postcreate.sh

@@ -0,0 +1,3 @@
+# Setup pre-commit
+pre-commit
+pre-commit install

.github/CODEOWNERS

@@ -1,4 +1,23 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 # Codeowners for reviews on PRs
 
-*  @bretbrownjr @camio @dietmarkuehl @neatudarius @steve-downey
+# Note(river):
+# **Please understand how codeowner file work before uncommenting anything in this section:**
+# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+#
+# For projects using exemplar as a template and intend to reuse its infrastructure,
+# River (@wusatosi) helped create most of the original infrastructure under the scope described below,
+# they are more than happy to help out with any PRs downstream,
+# as well as to sync any useful change upstream to exemplar.
+#
+# Github Actions:
+# .github/workflows/ @wusatosi # Add other project owners here
+#
+# Devcontainer:
+# .devcontainer/ @wusatosi # Add other project owners here
+#
+# Pre-commit:
+# .pre-commit-config.yaml @wusatosi # Add other project owners here
+# .markdownlint.yaml @wusatosi # Add other project owners here
+
+*  @bretbrownjr @camio @dietmarkuehl @neatudarius @steve-downey @wusatosi

.github/workflows/ci_tests.yml

@@ -31,12 +31,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        platform: [ubuntu-latest]
-        compiler:
-          - cpp: g++
+        platform:
+          - description: "Ubuntu GCC"
+            cpp: g++
             c: gcc
-          - cpp: clang++
+            os: ubuntu-latest
+          - description: "Ubuntu Clang"
+            cpp: clang++
             c: clang
+            os: ubuntu-latest
         cpp_version: [17, 20, 23, 26]
         cmake_args:
           - description: "Default"
@@ -46,59 +49,100 @@ jobs:
           - description: "ASan"
             args: "-DBEMAN_BUILDSYS_SANITIZER=ASan"
         include:
-          - platform: ubuntu-latest
-            compiler:
+          - platform:
+              description: "Ubuntu GCC"
               cpp: g++
               c: gcc
+              os: ubuntu-latest
             cpp_version: 17
             cmake_args:
               description: "Werror"
               args: "-DCMAKE_CXX_FLAGS='-Werror=all -Werror=extra'"
-          - platform: ubuntu-latest
-            compiler:
+          - platform:
+              description: "Ubuntu GCC"
               cpp: g++
               c: gcc
+              os: ubuntu-latest
             cpp_version: 17
             cmake_args:
               description: "Dynamic"
               args: "-DBUILD_SHARED_LIBS=on"
+          - platform:
+              description: "Windows MSVC"
+              cpp: cl
+              c: cl
+              os: windows-latest
+            cpp_version: 17
+            cmake_args:
+              description: "Default"
+              args: ""
+          - platform:
+              description: "Windows MSVC"
+              cpp: cl
+              c: cl
+              os: windows-latest
+            cpp_version: 17
+            cmake_args:
+              description: "ASan"
+              # Debug infomation needed to avoid cl: C5072
+              # https://learn.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-c5072?view=msvc-170
+              args: "-DCMAKE_CXX_FLAGS='/fsanitize=address /Zi'"
+
 
-    name: "Unit: ${{ matrix.compiler.c }} ${{ matrix.cpp_version }} ${{ matrix.cmake_args.description }}"
-    runs-on: ${{ matrix.platform }}
+    name: "Unit: ${{ matrix.platform.description }} ${{ matrix.cpp_version }} ${{ matrix.cmake_args.description }}"
+    runs-on: ${{ matrix.platform.os }}
     steps:
       - uses: actions/checkout@v4
       - name: Install Ninja
         uses: lukka/get-cmake@latest
         with:
           cmakeVersion: "~3.25.0"
           ninjaVersion: "^1.11.1"
+      - name: Setup MSVC
+        if: startsWith(matrix.platform.os, 'windows')
+        uses: TheMrMilchmann/setup-msvc-dev@v3
+        with:
+          arch: x64
       - name: Print installed softwares
+        shell: bash
         run: |
-          clang++ --version
-          g++ --version
+          echo "Compiler:"
+
+          # cl does not have a --version option
+          if [ "${{ matrix.platform.cpp }}" != "cl" ]; then
+            ${{ matrix.platform.cpp }} --version
+            ${{ matrix.platform.c }} --version
+          else
+            ${{ matrix.platform.cpp }}
+            ${{ matrix.platform.c }}
+          fi
+
+          echo "Build system:"
           cmake --version
           ninja --version
       - name: Configure CMake
         run: |
           cmake -B build -S . -DCMAKE_CXX_STANDARD=${{ matrix.cpp_version }} ${{ matrix.cmake_args.args }}
         env:
-          CC: ${{ matrix.compiler.c }}
-          CXX: ${{ matrix.compiler.cpp }}
+          CC: ${{ matrix.platform.c }}
+          CXX: ${{ matrix.platform.cpp }}
           CMAKE_GENERATOR: "Ninja Multi-Config"
       - name: Build Release
         run: |
+          # Portable commands only
           cmake --build build --config Release --verbose
           cmake --build build --config Release --target all_verify_interface_header_sets
           cmake --install build --config Release --prefix /opt/beman.exemplar
-          find /opt/beman.exemplar -type f
+          ls -R /opt/beman.exemplar
       - name: Test Release
         run: ctest --test-dir build --build-config Release
       - name: Build Debug
         run: |
+          # Portable commands only
           cmake --build build --config Debug --verbose
           cmake --build build --config Debug --target all_verify_interface_header_sets
           cmake --install build --config Debug --prefix /opt/beman.exemplar
-          find /opt/beman.exemplar -type f
+          ls -R /opt/beman.exemplar
       - name: Test Debug
         run: ctest --test-dir build --build-config Debug
 
@@ -130,16 +174,18 @@ jobs:
           CMAKE_GENERATOR: "Ninja Multi-Config"
       - name: Build Release
         run: |
+          # Portable commands only
           cmake --build build --config Release --verbose
           cmake --build build --config Release --target all_verify_interface_header_sets
           cmake --install build --config Release --prefix /opt/beman.exemplar
-          find /opt/beman.exemplar -type f
+          ls -R /opt/beman.exemplar
       - name: Build Debug
         run: |
+          # Portable commands only
           cmake --build build --config Debug --verbose
           cmake --build build --config Debug --target all_verify_interface_header_sets
           cmake --install build --config Debug --prefix /opt/beman.exemplar
-          find /opt/beman.exemplar -type f
+          ls -R /opt/beman.exemplar
 
   create-issue-when-fault:
     runs-on: ubuntu-latest

CMakeLists.txt

@@ -54,7 +54,6 @@ if(BEMAN_EXEMPLAR_BUILD_TESTS)
     )
     block()
         set(INSTALL_GTEST OFF) # Disable GoogleTest installation
-        set(BUILD_TESTING OFF) # Disable GoogleTest tests
         FetchContent_MakeAvailable(googletest)
     endblock()
 endif()

README.md

@@ -4,9 +4,9 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
 # beman.exemplar: A Beman Library Exemplar
 
-![Continuous Integration Tests](https://github.com/beman-project/exemplar/actions/workflows/ci_tests.yml/badge.svg)
+![Continuous Integration Tests](https://github.com/bemanproject/exemplar/actions/workflows/ci_tests.yml/badge.svg)
 
-`beman.exemplar` is a minimal C++ library conforming to [The Beman Standard](https://github.com/beman-project/beman/blob/main/docs/BEMAN_STANDARD.md).
+`beman.exemplar` is a minimal C++ library conforming to [The Beman Standard](https://github.com/bemanproject/beman/blob/main/docs/BEMAN_STANDARD.md).
 This can be used as a template for those intending to write Beman libraries.
 It may also find use as a minimal and modern  C++ project structure.