/gradle-helm-plugin

A Gradle plugin for building, publishing and managing Helm charts.

Primary LanguageKotlinMIT LicenseMIT

Gradle Helm Plugin

⚠️

The gradle-helm-plugin has moved!

As I lack the time to maintain this project at a satisfying level, it has found a new official home at Citi/gradle-helm-plugin.

Please use the plugins com.citi.helm etc instead from now on.

Also, please file any issues or PRs in that repository. Thank you and happy helming!

org.unbroken dome.helm?versionPrefix=2.0

This is a suite of Gradle plugins for building, publishing and managing Helm charts.

ℹ️
 Starting with version 1.0.0, the plugins require Helm 3.+.

Features

  • Gradle task types for common Helm CLI commands

  • Build, package and publish Helm charts using a declarative Gradle DSL

  • Resolve placeholders like ${chartVersion} from chart source files before packaging

  • Resolve dependencies between charts using Gradle artifact dependencies

  • Install, upgrade and uninstall releases to/from a Kubernetes cluster

Requirements

  • Gradle 5.2 or higher

  • JDK 1.8 or higher (for running Gradle)

  • Helm command-line client 3.+

Quick Start

Apply the org.unbroken-dome.helm plugin to your Gradle project:

build.gradle
plugins {
    id 'org.unbroken-dome.helm' version '2.0.0'
}
build.gradle.kts
plugins {
    id("org.unbroken-dome.helm") version "2.0.0"
}

Put your Helm chart sources into src/main/helm:

📂 (project root)
    📂 src
        📂 main
            📂 helm
                📂 templates
                    📄 ...
                📄 Chart.yaml
                📄 values.yaml

Use the helmPackage task to build your chart.

Further Documentation