Interface Linting

  • 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.HelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmValueOptions

    
    public interface Linting
     implements ConfigurableHelmValueOptions
                        

    Defines options for linting Helm charts using the helm lint command.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public interface Linting.Configuration

      A configuration of values to pass to helm lint.

    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      NamedDomainObjectContainer<Linting.Configuration> configurations(Action<NamedDomainObjectContainer<Linting.Configuration>> configureAction) Configures the linter configurations.
      abstract Property<Boolean> getEnabled() If true (the default), run the linter.
      abstract Property<Boolean> getStrict() If true, treat warnings from the linter as errors.
      abstract Property<Boolean> getWithSubcharts() If true, also lint dependent charts.
      abstract NamedDomainObjectContainer<Linting.Configuration> getConfigurations() A collection of linter configurations.
      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmValueOptions

        getFileValues, getValueFiles, getValues
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • configurations

         NamedDomainObjectContainer<Linting.Configuration> configurations(Action<NamedDomainObjectContainer<Linting.Configuration>> configureAction)

        Configures the linter configurations.

        Each configuration allows specifying a different set of values to pass to helm lint. Values defined in the Linting block directly are merged into all configurations.

        If no configurations are added to this container, the plugin will assume a single configuration named "default" with no additional values.

      • getEnabled

         abstract Property<Boolean> getEnabled()

        If true (the default), run the linter.

      • getStrict

         abstract Property<Boolean> getStrict()

        If true, treat warnings from the linter as errors.

        Corresponds to the --strict CLI option.

      • getWithSubcharts

         abstract Property<Boolean> getWithSubcharts()

        If true, also lint dependent charts.

        Corresponds to the --with-subcharts CLI option.

      • getConfigurations

         abstract NamedDomainObjectContainer<Linting.Configuration> getConfigurations()

        A collection of linter configurations.

        Each configuration allows specifying a different set of values to pass to helm lint. Values defined in the Linting block directly are merged into all configurations.

        If no configurations are added to this container, the plugin will assume a single configuration named "default" with no additional values.