Citi/gradle-helm-plugin

A suite of Gradle Plugins for
building, publishing and managing Helm Charts

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

Quick Start

Add com.citi.helm to your Gradle project:

plugins {
    id 'com.citi.helm' version '2.2.0'
}

plugins {
    id("com.citi.helm") version "2.2.0"
}

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

Requirements

• Gradle 7 or higher

• JDK 1.8 or higher (for running Gradle)

• Helm command-line client 3.+

Contributing

Your contributions are at the core of making this a true open source project. Any contributions you make are greatly appreciated.

We welcome you to:

• Fix typos or touch up documentation
• Share your opinions on existing issues
• Help expand and improve our library by opening a new issue

Please review our community contribution guidelines and functional contribution guidelines to get started 👍

Code of Conduct

We are committed to making open source an enjoyable and respectful experience for our community. See CODE_OF_CONDUCT for more information.

License

This project is distributed under the MIT License. See LICENSE for more information.

Contact

If you have a query or require support with this project, raise an issue. Otherwise, reach out to opensource@citi.com.