Package io.github.build.extensions.oss.gradle.plugins.helm.command.tasks

Class HelmPackage

  • All Implemented Interfaces:
    io.github.build.extensions.oss.gradle.plugins.helm.command.GlobalHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmOptions , kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable 
    
public class HelmPackage
extends AbstractHelmCommandTask

    Packages a chart into a versioned chart archive file. Corresponds to the helm package CLI command.

    The chart name and version need to be known at configuration time to determine the task outputs. If they are not specified explicitly using the chartName and chartVersion properties, the task will parse the Chart.yaml file and extract the missing information from there.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      HelmPackage()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final Property<String> getAppVersion() Set the appVersion on the chart to this version.
      final Property<Boolean> getUpdateDependencies() Update dependencies from "Chart.yaml" to dir "charts/" before packaging.
      final DirectoryProperty getSourceDir() The directory that contains the sources for the Helm chart.
      final Property<String> getChartName() The name of the chart.
      final Property<String> getChartVersion() The version of the chart.
      final DirectoryProperty getDestinationDir() Location to write the chart archive.
      final Provider<String> getChartFileName() The name of the packaged chart file.
      final Provider<RegularFile> getPackageFile() The full path of the packaged chart file (read-only property).
      final Provider<RegularFile> getChartOutputPath()
      final Unit helmPackage()

      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.tasks.AbstractHelmCommandTask

        getDebug, getExecutable, getExtraArgs, getXdgCacheHome, getXdgConfigHome, getXdgDataHome

      • Methods inherited from class org.gradle.api.internal.AbstractTask

        acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

      • Methods inherited from class org.gradle.api.DefaultTask

        compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • HelmPackage

        HelmPackage()

    • Method Detail

      • getAppVersion

        @Input()@Optional() final Property<String> getAppVersion()

        Set the appVersion on the chart to this version.

        Corresponds to the --app-version CLI option.

      • getUpdateDependencies

        @Input() final Property<Boolean> getUpdateDependencies()

        Update dependencies from "Chart.yaml" to dir "charts/" before packaging.

        Corresponds to the --dependency-update CLI option.

      • getSourceDir

        @InputDirectory() final DirectoryProperty getSourceDir()

        The directory that contains the sources for the Helm chart.

      • getChartName

        @Input() final Property<String> getChartName()

        The name of the chart.

        If not set, the chart name will be read from the Chart.yaml file in the source directory.

      • getChartVersion

        @Input() final Property<String> getChartVersion()

        The version of the chart.

        If not set, the chart version will be read from the Chart.yaml file in the source directory.

      • getDestinationDir

        @Internal(value = "Represented as part of packageFile") final DirectoryProperty getDestinationDir()

        Location to write the chart archive.

        Default destination is helm/charts/ under the project's build directory.

      • getChartFileName

        @Internal(value = "Represented as part of packageFile") final Provider<String> getChartFileName()

        The name of the packaged chart file.

      • getPackageFile

        @OutputFile() final Provider<RegularFile> getPackageFile()

        The full path of the packaged chart file (read-only property).

      • getChartOutputPath

        @Internal(value = "replaced by packageFile property") final Provider<RegularFile> getChartOutputPath()