helm_chart

A Helm chart

Backend: pants.backend.experimental.helm

chart

type: str | None
default: 'Chart.yaml'

The chart definition file

dependencies

type: Iterable[str] | None
default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib', 'helloworld/main.py:lib', '3rdparty:reqs#django'].

This augments any dependencies inferred by Pants, such as by analyzing your imports. Use ./pants dependencies or ./pants peek on this target to get the final result.

See Targets and BUILD files#target-addresses and Targets and BUILD files#target-generation for more about how addresses are formed, including for generated targets. You can also run ./pants list :: to find all addresses in your project, or ./pants list dir: to find all addresses defined in that directory.

If the target is in the same BUILD file, you can leave off the BUILD file path, e.g. :tgt instead of helloworld/subdir:tgt. For generated first-party addresses, use ./ for the file path, e.g. ./main.py:tgt; for all other generated targets, use :tgt#generated_name.

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description

type: str | None
default: None

A human-readable description of the target.

Use ./pants list --documented :: to see all targets with descriptions.

lint_strict

type: bool | None
default: None

If set to true, enables strict linting of this Helm chart

output_path

type: str | None
default: None

Where the built directory tree should be located.

If undefined, this will use the path to the BUILD file, For example, src/charts/mychart:tgt_name would be src.charts.mychart/tgt_name/.

Regardless of whether you use the default or set this field, the path will end with Helms's file format of <chart_name>-<chart_version>.tgz, where chart_name and chart_version are the values extracted from the Chart.yaml file. So, using the default for this field, the target src/charts/mychart:tgt_name might have a final path like src.charts.mychart/tgt_name/mychart-0.1.0.tgz.

When running ./pants package, this path will be prefixed by --distdir (e.g. dist/).

Warning: setting this value risks naming collisions with other package targets you may have.

skip_push

type: bool
default: False

If set to true, do not push this helm chart to registries when running ./pants publish.

sources

type: Iterable[str] | None
default: ('values.yaml', 'templates/*.yaml', 'templates/*.tpl')

A list of files and globs that belong to this target.

Paths are relative to the BUILD file's directory. You can ignore files/globs by prefixing them with !.

Example: sources=['example.ext', 'test_*.ext', '!test_ignore.ext'].

tags

type: Iterable[str] | None
default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run ./pants --tag='integration_test' test :: to only run on targets with that tag.


Did this page help you?