docs: correct platform capabilities and add changelog #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| on: | |
| push: | |
| branches: [master] | |
| pull_request: | |
| jobs: | |
| linux: | |
| name: Linux (ubuntu-latest) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Configure | |
| run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -DSYSMON_WARNINGS_AS_ERRORS=ON | |
| - name: Build | |
| run: cmake --build build --parallel | |
| - name: Test | |
| run: ctest --test-dir build --output-on-failure | |
| - name: CLI smoke tests | |
| run: | | |
| ./build/sysmon --version | |
| ./build/sysmon --help | |
| ./build/sysmon --once --no-tui | |
| - name: Install smoke test | |
| run: | | |
| cmake --install build --prefix "$PWD/stage" | |
| ./stage/bin/sysmon --version | |
| macos-arm64: | |
| name: macOS (Apple Silicon) | |
| runs-on: macos-15 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Environment | |
| run: | | |
| uname -a | |
| uname -m | |
| sw_vers | |
| clang++ --version | |
| cmake --version | |
| - name: Verify architecture | |
| run: test "$(uname -m)" = "arm64" | |
| - name: Configure | |
| run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -DSYSMON_WARNINGS_AS_ERRORS=ON | |
| - name: Build | |
| run: cmake --build build --parallel | |
| - name: Test | |
| run: ctest --test-dir build --output-on-failure | |
| - name: CLI smoke tests | |
| run: | | |
| ./build/sysmon --version | |
| ./build/sysmon --help | |
| ./build/sysmon --once --no-tui | |
| - name: Install smoke test | |
| run: | | |
| cmake --install build --prefix "$PWD/stage" | |
| ./stage/bin/sysmon --version | |
| macos-intel: | |
| name: macOS (Intel) | |
| runs-on: macos-15-intel | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Environment | |
| run: | | |
| uname -a | |
| uname -m | |
| sw_vers | |
| clang++ --version | |
| cmake --version | |
| - name: Verify architecture | |
| run: test "$(uname -m)" = "x86_64" | |
| - name: Configure | |
| run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -DSYSMON_WARNINGS_AS_ERRORS=ON | |
| - name: Build | |
| run: cmake --build build --parallel | |
| - name: Test | |
| run: ctest --test-dir build --output-on-failure | |
| - name: CLI smoke tests | |
| run: | | |
| ./build/sysmon --version | |
| ./build/sysmon --help | |
| ./build/sysmon --once --no-tui | |
| - name: Install smoke test | |
| run: | | |
| cmake --install build --prefix "$PWD/stage" | |
| ./stage/bin/sysmon --version | |
| sanitizers: | |
| name: Sanitizers (Linux, ASan + UBSan) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Configure | |
| env: | |
| CC: clang | |
| CXX: clang++ | |
| run: cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON \ | |
| -DCMAKE_CXX_FLAGS="-fsanitize=address,undefined -fno-omit-frame-pointer" \ | |
| -DCMAKE_EXE_LINKER_FLAGS="-fsanitize=address,undefined" \ | |
| -DSYSMON_WARNINGS_AS_ERRORS=ON | |
| - name: Build | |
| run: cmake --build build --parallel | |
| - name: Test | |
| env: | |
| ASAN_OPTIONS: detect_leaks=1 | |
| run: ctest --test-dir build --output-on-failure | |
| - name: CLI smoke tests under sanitizers | |
| env: | |
| ASAN_OPTIONS: detect_leaks=1 | |
| run: | | |
| ./build/sysmon --version | |
| ./build/sysmon --once --no-tui | |
| documentation: | |
| name: Documentation (Sphinx) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install -r docs/requirements.txt | |
| - name: Build Sphinx docs (warnings are errors) | |
| run: sphinx-build -W --keep-going -b html docs/source docs/_build/html | |
| - name: Check links | |
| run: sphinx-build -b linkcheck docs/source docs/_build/linkcheck |