Skip to content

CI/CD Pipelines

Continuous integration, multi-platform build matrix, and automated verification pipelines for siddiqsoft::sip2json.

Pipeline Architecture

Defined in azure-pipelines.yml on self-hosted agents (Default pool):

flowchart TD
    subgraph Triggers["Trigger"]
        T1["Push to master / main / release/*"]
        T2["Pull Request"]
    end

    subgraph Matrix["Build Matrix"]
        W["Windows Stage (MSVC)"]
        L["Linux Stage (GCC & Clang)"]
        D["Darwin Stage (AppleClang)"]
    end

    subgraph Verification["Verification"]
        V1["CTest Execution"]
        V2["Benchmark Collection"]
        V3["Coverage (gcovr)"]
    end

    subgraph Publish["Publication (main / master)"]
        G1{"GitHub Release Approval"}
        P1["GitHub Release"]
        P0["NuGet Package"]
        P2["MkDocs Site (Linux / macOS)"]
    end

    T1 --> Matrix
    T2 --> Matrix
    W --> Verification
    L --> Verification
    D --> Verification
    Verification --> G1
    G1 --> P1
    P1 --> P0
    G1 --> P2

Build Stages & Platform Matrix

The build matrix targets Windows, Linux, and macOS (Darwin) across x64 and arm64 architectures:

Platform Stage Target Architectures Compilers CMake Presets Prefix CI Template Artifacts Published
Windows x64, arm64 MSVC (Visual Studio 2022) Windows-${arch}-${buildType} .azure/az-build-windows.yml Binaries, CTest JUnit XML, Benchmarks
Linux x64, arm64 Clang (17+), GCC (13+) Linux-${compiler}-${buildType} .azure/az-build-unix.yml Binaries, CTest JUnit XML, Benchmarks, Coverage XML
Darwin (macOS) x64, arm64 AppleClang (Xcode / CLT) Apple-Clang-${buildType} .azure/az-build-unix.yml Binaries, CTest JUnit XML, Benchmarks

Note

Unified Unix Pipeline: The Linux and Darwin stages share the parameterized template .azure/az-build-unix.yml. It dynamically adapts agent OS demands, compiler flags, and preset names based on the target platform (e.g. Darwin maps to cmakePresetPrefix: Apple-, producing Apple-Clang-Release and Apple-Clang-Debug).

Pipeline Parameters Reference

When manually triggering a pipeline in Azure DevOps, maintainers can customize:

Parameter Type Default Allowed Values Purpose
Platforms stringList [ Windows, Linux, Darwin ] Windows, Linux, Darwin Target OS platforms to build
Architectures stringList [ arm64 ] arm64, x64 Target CPU architectures
Compilers_Windows stringList [ MSVC ] MSVC Windows compiler toolsets
Compilers_Linux stringList [ Clang ] Clang, GCC Linux compiler toolsets
Compilers_Darwin stringList [ Clang ] Clang macOS compiler toolsets (AppleClang)
BuildTypes stringList [ Release ] Release, Debug Build configurations
RunTests boolean true true, false Execute unit and compliance test suites
RunBenchmarks boolean true true, false Execute performance benchmark harnesses
PublishNuGet boolean false true, false Trigger NuGet Release (auto on master/main)
PublishGitHub boolean false true, false Trigger GitHub Release (auto on master/main)
PublishDocs boolean false true, false Publish documentation site via Linux or macOS agent (auto on master/main)
DocAgentOS string Linux Linux, Darwin Build agent OS for documentation publication stage (Windows disallowed)
Cleanup boolean false true, false Run cache and workspace cleanup only
  • Maintainer Guide: Codebase architecture, source mapping, and bulk formatting
  • CMake Presets: Presets executed across each build stage
  • Build Agent Requirements: Agent demands, OS setup, and toolchain versions
  • release guidelines: Publishing packages and release approvals