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

Class AbstractHelmCommandTask

  • All Implemented Interfaces:
    io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableGlobalHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmOptions , 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 
    @DisableCachingByDefault(because = "See https://github.com/build-extensions-oss/gradle-helm-plugin/issues/208") 
public abstract class AbstractHelmCommandTask
extends DefaultTask implements ConfigurableGlobalHelmOptions

    Base class for tasks that invoke a Helm CLI command.

    All the global options below are plain task properties whose conventions are wired from the helm extension by the HelmCommandsPlugin. They deliberately do not hold on to the extension object itself: the extension is part of the project model, and storing it in task state makes the task unserializable for the configuration cache.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Property<String> getExecutable() The name or path of the Helm executable.
      abstract Property<Boolean> getDebug() Indicates whether to use the verbose output (--debug flag) when invoking commands.
      abstract ListProperty<String> getExtraArgs() Additional command-line arguments to pass to the Helm CLI.
      abstract DirectoryProperty getXdgDataHome() Base directory for storing data.
      abstract DirectoryProperty getXdgConfigHome() Base directory for storing configuration.
      abstract DirectoryProperty getXdgCacheHome() Base directory for storing cached data.

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

        getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, setActions, setDescription, setDidWork, setEnabled, setEnabled, setGroup

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

        getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getLoggingManager, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getReasonsNotToTrackState, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, setImpliesSubProjects

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

        configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setDependsOn, setFinalizedBy, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

      • Methods inherited from class kotlin.Comparable

        compareTo

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

        acceptServiceReferences, appendParallelSafeAction, doNotTrackStateIf, hasTaskActions, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AbstractHelmCommandTask

        AbstractHelmCommandTask()

    • Method Detail

      • getExecutable

        @Input() abstract Property<String> getExecutable()

        The name or path of the Helm executable.

        Defaults to the executable configured on the helm extension, falling back to the automatically downloaded client (if that is enabled), and finally to helm as found on the PATH.

      • getDebug

        @Console() abstract Property<Boolean> getDebug()

        Indicates whether to use the verbose output (--debug flag) when invoking commands.

      • getExtraArgs

        @Input() abstract ListProperty<String> getExtraArgs()

        Additional command-line arguments to pass to the Helm CLI.

        This can be used for command-line options that have no counterpart in the plugin.

      • getXdgDataHome

        @Internal() abstract DirectoryProperty getXdgDataHome()

        Base directory for storing data.

        Corresponds to the XDG_DATA_HOME environment variable. If not set, defaults to helm/data inside the project build directory.

        See [https://helm.sh/docs/helm/helm/] for details about how XDG base directories are used by the Helm CLI.

      • getXdgConfigHome

        @Internal() abstract DirectoryProperty getXdgConfigHome()

        Base directory for storing configuration.

        Corresponds to the XDG_CONFIG_HOME environment variable. If not set, defaults to helm/config inside the project build directory.

        See [https://helm.sh/docs/helm/helm/] for details about how XDG base directories are used by the Helm CLI.

      • getXdgCacheHome

        @Internal() abstract DirectoryProperty getXdgCacheHome()

        Base directory for storing cached data.

        Corresponds to the XDG_CACHE_HOME environment variable. If not set, defaults to .gradle/helm/cache inside the root project directory.

        See [https://helm.sh/docs/helm/helm/] for details about how XDG base directories are used by the Helm CLI.