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

Class HelmLint

  • All Implemented Interfaces:
    io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmValueOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.GlobalHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmValueOptions , 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 HelmLint
extends AbstractHelmCommandTask implements ConfigurableHelmValueOptions

    Runs a series of tests to verify that a chart is well-formed. Corresponds to the helm lint CLI command.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      HelmLint()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final DirectoryProperty getChartDir() The directory that contains the sources for the Helm chart.
      final Property<Boolean> getStrict() If set to true, fail on warnings emitted by the linter.
      final MapProperty<String, Object> getValues() Values to be passed directly.
      final MapProperty<String, Object> getFileValues() Values read from the contents of files.
      final ConfigurableFileCollection getValueFiles() A collection of YAML files containing values.
      final Property<Boolean> getWithSubcharts() If true, also lint dependent charts.
      final RegularFileProperty getOutputMarkerFile() If set, the task will create an empty marker file at this path after a successful call to helm lint.
      final Unit lint()

      • 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

      • HelmLint

        HelmLint()

    • Method Detail

      • getChartDir

        @InputDirectory()@SkipWhenEmpty() final DirectoryProperty getChartDir()

        The directory that contains the sources for the Helm chart.

      • getStrict

        @Input()@Optional() final Property<Boolean> getStrict()

        If set to true, fail on warnings emitted by the linter.

      • getValues

        @Input() final MapProperty<String, Object> getValues()

        Values to be passed directly.

        Entries in the map will be sent to the CLI using either the --set-string option (for strings) or the --set option (for all other types).

      • getFileValues

        @Input() final MapProperty<String, Object> getFileValues()

        Values read from the contents of files.

        Corresponds to the --set-file CLI option.

        The values of the map can be of any type that is accepted by Project.file. Additionally, when adding a Provider that represents an output file of another task, the consuming task will automatically have a task dependency on the producing task.

        Not to be confused with valueFiles, which contains a collection of YAML files that supply multiple values.

      • getValueFiles

        @InputFiles() final ConfigurableFileCollection getValueFiles()

        A collection of YAML files containing values.

        Corresponds to the --values CLI option.

        Not to be confused with fileValues, which contains entries whose values are the contents of files.

      • getWithSubcharts

        @Input()@Optional() final Property<Boolean> getWithSubcharts()

        If true, also lint dependent charts.

        Corresponds to the --with-subcharts CLI option.

      • getOutputMarkerFile

        @OutputFile()@Optional() final RegularFileProperty getOutputMarkerFile()

        If set, the task will create an empty marker file at this path after a successful call to helm lint.

        This is necessary for Gradle's up-to-date checking because helm lint itself doesn't output any files.