Harmont docs
Pipeline SDKReferenceToolchains

Ruby

Generated reference for the harmont Ruby API.

ruby

Callable singleton for the Ruby toolchain — access as hm.ruby.

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

ruby(*, path='.', version='default', image=None, base=None) -> RubyProject
ParameterTypeDefaultDescription
pathstr'.'Path to the Ruby project root (must contain a
Gemfile.lock).
versionstr'default'Ruby version. Currently only "default" is supported
(installs whichever ruby-full ships in the apt repository).
Pinned versions require rbenv/asdf support, which is not yet
implemented.
imagestr | NoneNoneLocal-mode Docker base image override.
baseStep | NoneNoneExisting Step to attach to instead of emitting a fresh
apt-base step.

Returns RubyProject — A RubyProject whose installed step is bundle install.

ruby.lint()

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

Returns Step

ruby.test()

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

Returns Step

RubyEntry

Callable singleton for the Ruby toolchain — access as hm.ruby.

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

RubyEntry.lint()

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

Returns Step

RubyEntry.test()

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

Returns Step

RubyProject

Ruby project install chain — constructed via hm.ruby().

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

Fields

FieldTypeDefault
pathstrrequired
installedSteprequired

RubyProject.lint()

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

Returns Step

RubyProject.test()

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

Returns Step

On this page