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

Class HelmFilterSources

  • All Implemented Interfaces:
    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 HelmFilterSources
extends DefaultTask

    Processes the Helm chart sources and copies them into an intermediate directory.

    This task has several purposes:

    • apply a filtering transformation (i.e. placeholder resolution) transformation on certain source files, as specified by the filtering property. For example, the placeholder ${chartVersion} in the _Chart.yaml_ file will be replaced by the actual chartVersion` value.

    • copy the chart source files into an intermediate directory that has the same name as the chart, as is required by the helm package command.

    • 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
      final Property<String> getConfiguredChartName() The name of the chart within the helm.charts DSL container.
      final Property<String> getChartName() The chart name.
      final Property<String> getChartVersion() The chart version.
      final DirectoryProperty getSourceDir() The directory that contains the chart sources.
      final DirectoryProperty getTargetDir() The target directory, where the task will place the filtered sources.
      final Property<Boolean> getOverrideChartInfo() If true (the default), the name and version entries in the Chart.
      final Filtering getFiltering() Settings that control filtering of the chart sources.
      final Unit filtering(Action<Filtering> configureAction) Configures filtering for this task.
      final Unit filterSources()

      • 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

      • HelmFilterSources

        HelmFilterSources()

    • Method Detail

      • getConfiguredChartName

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

        The name of the chart within the helm.charts DSL container.

      • getSourceDir

        @InputDirectory() final DirectoryProperty getSourceDir()

        The directory that contains the chart sources.

      • getTargetDir

        @OutputDirectory() final DirectoryProperty getTargetDir()

        The target directory, where the task will place the filtered sources.

      • getOverrideChartInfo

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

        If true (the default), the name and version entries in the Chart.yaml file will be overridden with the actual values of chartName and chartVersion, respectively.