Harmont docs
Pipeline SDKReferenceToolchains

CMake

Generated reference for the harmont CMake API.

cmake

Callable singleton for the CMake toolchain — access as hm.cmake.

Call directly to construct a CMakeProject, or use the bare-form action methods (cmake.build(), cmake.test(), etc.) for a one-shot leaf.

cmake(*, path='.', lang='c', image=None, base=None) -> CMakeProject
ParameterTypeDefaultDescription
pathstr'.'Path to the project root (where CMakeLists.txt lives).
langstr'c'Language tag, either "c" or "cpp". Affects label
prefixes only; the cmake commands are identical.
imagestr | NoneNoneLocal-mode Docker base image override.
baseStep | NoneNoneExisting Step to attach to instead of emitting a fresh
apt-base step.

Returns CMakeProject — A CMakeProject ready for action methods.

cmake.build()

build(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

cmake.configure()

configure(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

cmake.fmt()

fmt(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

cmake.test()

test(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

CMakeEntry

Callable singleton for the CMake toolchain — access as hm.cmake.

Call directly to construct a CMakeProject, or use the bare-form action methods (cmake.build(), cmake.test(), etc.) for a one-shot leaf.

CMakeEntry.build()

build(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

CMakeEntry.configure()

configure(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

CMakeEntry.fmt()

fmt(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

CMakeEntry.test()

test(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

CMakeProject

CMake (C/C++) project install chain — constructed via hm.cmake().

installed is the cmake-verify step. Action methods (configure, build, test, fmt) attach leaves to installed.

Fields

FieldTypeDefault
pathstrrequired
installedSteprequired

CMakeProject.build()

build(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

CMakeProject.configure()

configure(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

CMakeProject.fmt()

fmt(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

CMakeProject.test()

test(**kw) -> Step
ParameterTypeDefaultDescription
kwAny{}

Returns Step

On this page