Harmont docs
Pipeline SDKReferenceToolchains

Composer

Generated reference for the harmont Composer API.

composer

Callable singleton for the Composer toolchain — access as hm.composer.

Call directly to construct a ComposerProject, or use the bare-form action methods (composer.test(), composer.lint()) for a one-shot leaf.

composer(*, path='.', laravel=False, image=None, base=None) -> ComposerProject
ParameterTypeDefaultDescription
pathstr'.'Path to the PHP project root (must contain a
composer.lock).
laravelboolFalseWhen True, uses php artisan test for .test()
and sets the label prefix to :laravel: instead of
:php:.
imagestr | NoneNoneLocal-mode Docker base image override.
baseStep | NoneNoneExisting Step to attach to instead of emitting a fresh
apt-base step.

Returns ComposerProject — A ComposerProject whose installed step is composer install.

composer.lint()

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

Returns Step

composer.test()

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

Returns Step

ComposerEntry

Callable singleton for the Composer toolchain — access as hm.composer.

Call directly to construct a ComposerProject, or use the bare-form action methods (composer.test(), composer.lint()) for a one-shot leaf.

ComposerEntry.lint()

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

Returns Step

ComposerEntry.test()

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

Returns Step

ComposerProject

Composer (PHP/Laravel) project install chain — constructed via hm.composer().

installed is the composer install step. Action methods (test, lint) attach leaves to installed.

Fields

FieldTypeDefault
pathstrrequired
installedSteprequired

ComposerProject.lint()

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

Returns Step

ComposerProject.test()

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

Returns Step

On this page