Configures and builds a CMake project. Supports both CMakePresets.json preset-based builds and manual generator/config/platform builds.

stages {
    git.sync()
    cmake.build()
    // ...
}

With overrides:

stages {
    git.sync()
    cmake.build(
        CMAKE_BUILD_PRESETS: ['debug-build', 'release-build']
    )
    // ...
}

Manual mode (no presets):

stages {
    git.sync()
    cmake.build(
        CMAKE_SOURCE_DIR: 'engine',
        CMAKE_GENERATOR_CHOICES: ['Ninja', 'Visual Studio 17 2022']
    )
    // ...
}

• CMake installed and on PATH on the build agent
• Visual Studio installed (located automatically via vswhere.exe)
• A CMakePresets.json in the project root (for preset-based builds)

When CMakePresets.json is detected, the pipeline shows preset-based parameters:

When no presets are found, the pipeline falls back to manual parameters:

The module discovers presets in order:

1. Override lists — Presets passed directly in the Jenkinsfile (e.g., CMAKE_BUILD_PRESETS: [...])
2. Workspace file — Reads CMakePresets.json from the workspace (fast path, works when the workspace persists between builds)
3. VCS remote — Fetches CMakePresets.json from the Git or Perforce remote (auto-detected from pipeline parameters)

Note: On the very first run, presets may not be available yet. Run the job once so the library can discover your presets, then subsequent runs will show preset dropdowns.

Preset mode:

1. Derives the configure preset from the selected build preset
2. Runs cmake --preset <configure-preset> (with any extra CMAKE_ARGS)
3. Runs cmake --build --preset <build-preset> (with any extra CMAKE_BUILD_ARGS)

Manual mode:

1. Runs cmake -S <source> -B <build> -G <generator> -DCMAKE_BUILD_TYPE=<config> (adds -A <platform> for Visual Studio generators)
2. Runs cmake --build <build> --config <config>

Before running any CMake command, the module automatically:

1. Locates the latest Visual Studio installation using vswhere.exe
2. Runs vcvarsall.bat with the correct architecture (x64, x86, or amd64_arm64)

This ensures compilers and build tools are available without manual setup.

After execution, cmake.build() sets the following on the pipeline context:

Override default choices by passing maps to cmake.build():

• cmake.test() — Run CTest with preset or manual configuration
• cmake.pack() — Package build output with CPack
• cmake.workflow() — Run a full CMake workflow preset

These methods are available on the cmake object for advanced or custom pipelines: