Built by Maven

helm:deploy-helm

Full name:

de.eitco.cicd.helm:helm-maven-plugin:4.0.3:deploy-helm

Description:

This goal deploys the generated helm package to a remote repository.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: deploy.

Optional Parameters

Name Type Since Description
<appVersion> String - This parameter specifies the version of the application contained in the helm chart.
Default: ${project.version}
User Property: helm.app.version
<artifactFile> String -
Deprecated.
No reason given

This parameter overrides the file name to deploy. If not set the file name is derived from the config given.
This parameter is deprecated - deriving the filename from the configuration is more convenient and straight forward.
<chartDescription> String - This parameter specifies the description of the helm chart.
Default: ${project.description}
User Property: helm.chart.description
<chartName> String - This parameter specifies the name of the helm chart.
Default: ${project.artifactId}
User Property: helm.chart.name
<chartType> String - This parameter specifies the type of the helm chart.
Default: application
User Property: helm.chart.type
<chartVersion> String - This parameter specifies the version of the helm chart.
Default: ${project.version}
User Property: helm.chart.version
<defaultRepository> String - The id of the default repository in the map helmRepositories.
Default: charts.helm.sh
<distributionServerId> String - This parameter specifies the settings.xml's server id for the remote repository. It is used when for authentication.
User Property: helm.distribution.server.id
<helmRepositories> Map<String,String> - This parameter specifies a map of helm repositories to read from and write to. To add credentials specify a server element in your maven settings.xml with the same id as the key in this map.
<skip> boolean 2.0.0 When true, skip the execution.
User Property: wagon.skip
<sourceDirectory> File - This parameter specifies the directory where to put the sources of the helm chart.
Default: src/main/helm
User Property: helm.source.directory

Parameter Details

<appVersion>

This parameter specifies the version of the application contained in the helm chart.
  • Type: java.lang.String
  • Required: No
  • User Property: helm.app.version
  • Default: ${project.version}

<artifactFile>

Deprecated.
No reason given

This parameter overrides the file name to deploy. If not set the file name is derived from the config given.
This parameter is deprecated - deriving the filename from the configuration is more convenient and straight forward.
  • Type: java.lang.String
  • Required: No

<chartDescription>

This parameter specifies the description of the helm chart.
  • Type: java.lang.String
  • Required: No
  • User Property: helm.chart.description
  • Default: ${project.description}

<chartName>

This parameter specifies the name of the helm chart.
  • Type: java.lang.String
  • Required: No
  • User Property: helm.chart.name
  • Default: ${project.artifactId}

<chartType>

This parameter specifies the type of the helm chart.
  • Type: java.lang.String
  • Required: No
  • User Property: helm.chart.type
  • Default: application

<chartVersion>

This parameter specifies the version of the helm chart.
  • Type: java.lang.String
  • Required: No
  • User Property: helm.chart.version
  • Default: ${project.version}

<defaultRepository>

The id of the default repository in the map helmRepositories.
  • Type: java.lang.String
  • Required: No
  • Default: charts.helm.sh

<distributionServerId>

This parameter specifies the settings.xml's server id for the remote repository. It is used when for authentication.
  • Type: java.lang.String
  • Required: No
  • User Property: helm.distribution.server.id

<helmRepositories>

This parameter specifies a map of helm repositories to read from and write to. To add credentials specify a server element in your maven settings.xml with the same id as the key in this map.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<skip>

When true, skip the execution.
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • User Property: wagon.skip

<sourceDirectory>

This parameter specifies the directory where to put the sources of the helm chart.
  • Type: java.io.File
  • Required: No
  • User Property: helm.source.directory
  • Default: src/main/helm