ifdef::env-github[] :tip-caption: :bulb: :note-caption: :information_source: :important-caption: :heavyexclamationmark: :caution-caption: :fire: :warning-caption: :warning: endif::[]

= Gradle Helm Plugin :version: 2.0.0 :pluginId: org.unbroken-dome.helm

[WARNING] ==== 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 https://github.com/Citi/gradle-helm-plugin[Citi/gradle-helm-plugin].

Please use the plugins https://plugins.gradle.org/plugin/com.citi.helm[com.citi.helm] etc instead from now on.

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

image:https://img.shields.io/gradle-plugin-portal/v/{pluginId}?versionPrefix={version}[link=https://plugins.gradle.org/plugin/{pluginId}/{version}]

This is a suite of Gradle plugins for building, publishing and managing https://www.helm.sh/[Helm] charts.

NOTE: 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 {pluginId} plugin to your Gradle project:

.build.gradle [source,groovy,subs="attributes"]

---

plugins { id '{pluginId}' version '{version}' }

---

.build.gradle.kts [source,kotlin,subs="attributes"]

---

plugins { id("{pluginId}") version "{version}" }

---

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

• https://unbroken-dome.github.io/projects/gradle-helm-plugin/[User Manual]
• https://unbroken-dome.github.io/projects/gradle-helm-plugin/dokka/gradle-helm-plugin/[API/DSL Documentation]