WorkflowPresets Properties

.. This file was generated by Utilities/Scripts/regenerate-presets.py from Help/manual/presets/schema.yaml. Do not edit.

.. _CMakePresets.workflowPresets.name:

name A required string representing the machine-friendly name of the preset. This identifier is used in the :option:cmake --workflow --preset <cmake--workflow --preset> option. There must not be two workflow presets in the union of CMakePresets.json and CMakeUserPresets.json in the same directory with the same name. However, a workflow preset may have the same name as a configure, build, test, or package preset.

.. _CMakePresets.workflowPresets.vendor:

vendor An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, it should follow the same conventions as the root-level vendor field. If vendors use their own per-preset vendor field, they should implement inheritance in a sensible manner when appropriate.

.. _CMakePresets.workflowPresets.displayName:

displayName An optional string with a human-friendly name of the preset.

.. _CMakePresets.workflowPresets.description:

description An optional string with a human-friendly description of the preset.

.. _CMakePresets.workflowPresets.steps:

steps A required array of objects describing the steps of the workflow. The first step must be a configure preset, and all subsequent steps must be non-configure presets whose configurePreset field matches the starting configure preset. Each object may contain the following fields:

.. include:: presets/steps-properties.rst