Class HelmPackage
-
- 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 HelmPackage extends AbstractHelmCommandTask
Packages a chart into a versioned chart archive file. Corresponds to the
helm packageCLI 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.yamlfile and extract the missing information from there.
-
-
Field Summary
Fields Modifier and Type Field Description private final Property<String>appVersionprivate final Property<Boolean>updateDependenciesprivate final DirectoryPropertysourceDirprivate final Property<String>chartNameprivate final Property<String>chartVersionprivate final DirectoryPropertydestinationDirprivate final Provider<String>chartFileNameprivate final Provider<RegularFile>packageFileprivate final Provider<RegularFile>chartOutputPathprivate final Property<String>executableprivate final Property<Boolean>debugprivate final ListProperty<String>extraArgsprivate final DirectoryPropertyxdgDataHomeprivate final DirectoryPropertyxdgConfigHomeprivate final DirectoryPropertyxdgCacheHomeprivate final TaskOutputsInternaloutputsprivate final Spec<in TaskInternal>onlyIfprivate final Property<Duration>timeoutprivate final TaskRequiredServicesrequiredServicesprivate final TaskDependencyInternaltaskDependenciesprivate final Set<Object>dependsOnprivate final TaskDestroyablesdestroyablesprivate final Loggerloggerprivate final Stringpathprivate final Factory<File>temporaryDirFactoryprivate final Optional<String>reasonTaskIsIncompatibleWithConfigurationCacheprivate final TaskLocalStatelocalStateprivate final List<InputChangesAwareTaskAction>taskActionsprivate final TaskDependencyInternallifecycleDependenciesprivate BooleanisEnabledprivate BooleanimpliesSubProjectsprivate final TaskInputsInternalinputsprivate Booleanenabledprivate final TaskStateInternalstateprivate final TaskIdentity<?>taskIdentityprivate final TaskDependencyshouldRunAfterprivate final ExtensionContainerextensionsprivate final BooleanisCompatibleWithConfigurationCacheprivate final TaskDependencyfinalizedByprivate final AntBuilderantprivate final DynamicObjectasDynamicObjectprivate final List<ResourceLock>sharedResourcesprivate BooleandidWorkprivate final Optional<String>reasonNotToTrackStateprivate Stringgroupprivate final Set<String>reasonsNotToTrackStateprivate final BooleanisHasCustomActionsprivate List<Action<in Task>>actionsprivate final Stringnameprivate final FiletemporaryDirprivate final LoggingManagerloggingprivate final PathidentityPathprivate final LoggingManagerInternalloggingManagerprivate final TaskDependencymustRunAfterprivate final StandardOutputCapturestandardOutputCaptureprivate final Projectprojectprivate Stringdescription
-
Constructor Summary
Constructors Constructor Description HelmPackage()
-
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 DirectoryPropertygetSourceDir()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 DirectoryPropertygetDestinationDir()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()The full path of the packaged chart file (read-only property). final UnithelmPackage()-
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.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
-
-
Method Detail
-
getAppVersion
@Input()@Optional() final Property<String> getAppVersion()
Set the appVersion on the chart to this version.
Corresponds to the
--app-versionCLI option.
-
getUpdateDependencies
@Input() final Property<Boolean> getUpdateDependencies()
Update dependencies from "Chart.yaml" to dir "charts/" before packaging.
Corresponds to the
--dependency-updateCLI 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()
The full path of the packaged chart file (read-only property).
-
helmPackage
final Unit helmPackage()
-
-
-
-