HelmPublish

HelmPublish - Tags

JFrog Pipelines Documentation

Products

JFrog Pipelines

Content Type

User Guide

ft:sourceType

Paligo

This topic lists tags that can be used with HelmPublish Pipeline steps. For more information about HelmPublish Pipeline steps, see HelmPublish.

name

An alphanumeric string (underscores are permitted) that identifies the step.

type

Must be HelmPublish for this step type.

configuration

Specifies all configuration selections for the step's execution environment. This step inherits the Bash/ PowerShell step configuration tags, including these pertinent tags:

Tag	Description of usage	Required/Optional
`inputResources`	Must specify a GitRepo resource that contains the Helm chart. The step will package the chart into a versioned chart archive file.	Required
`outputResources`	Must specify a HelmChart resource to update. The `version` property of the HelmChart is automatically set to the new chart version. Must specify a BuildInfo resource when `autoPublishBuildInfo` is set to true. If `JFROG_CLI_BUILD_NAME` or `JFROG_CLI_BUILD_NUMBER` is set as an environment variable for the pipeline or the step, that name and/or number is used for the output BuildInfo. Otherwise, the default `buildName` and `buildNumber` are `$pipeline_name` and `$run_number.`	Required May be required

Tag

Description of usage

Required/Optional

inputResources

Must specify a GitRepo resource that contains the Helm chart.

The step will package the chart into a versioned chart archive file.

Required

outputResources

Must specify a HelmChart resource to update. The version property of the HelmChart is automatically set to the new chart version.

Must specify a BuildInfo resource when autoPublishBuildInfo is set to true. If JFROG_CLI_BUILD_NAME or JFROG_CLI_BUILD_NUMBER is set as an environment variable for the pipeline or the step, that name and/or number is used for the output BuildInfo. Otherwise, the default buildName and buildNumber are $pipeline_name and $run_number.

Required

May be required

In addition, these tags can be defined to support the step's native operation:

Tags derived from Bash

All native steps derive from the Bash step. This means that all steps share the same base set of tags from Bash, while native steps have their own additional tags as well that support the step's particular function. So it's important to be familiar with the Bash step definition, since it's the core of the definition of all other steps.

Tag	Description of usage	Required/Optional
`helmVersion`	A number representing the major version of Helm to use. Can be 2 or 3. Defaults to 2.	Optional
`chartPath`	The path to the Helm chart in the GitRepo	Required
`flags`	Command line options to pass to the helm package command.	Optional
`lint`	When true, performs a lint test to verify that the chart is well formed. Defaults to false.	Optional
`lintFlags`	Options string to pass to the `helm lint`command.	Optional
`valueFilePaths`	Specifies values YAML file(s) that will be used in the lint command helm lint command. All environment variable references in the specified file(s) will be automatically replaced with values of matching runtime environment variables.	Optional
`autoPublishBuildInfo`	When true, publishes build info with the Helm chart. Default is false.	Optional

execution

Declares collections of shell command sequences to perform for pre- and post-execution phases:

Tag	Description of usage	Required/Optional
`onStart`	Commands to execute in advance of the native operation	Optional
`onSuccess`	Commands to execute on successful completion	Optional
`onFailure`	Commands to execute on failed completion	Optional
`onComplete`	Commands to execute on any completion	Optional

The actions performed for the onExecute phase are inherent to this step type and may not be overridden.