Container Gradle Plugin

Container is a Gradle plugin that enhances build portability, reproducibility, and flexibility by integrating containers into Gradle tasks. It provides a declarative and familiar way to run task operations inside containers and declare containers as task inputs and outputs.

Status

⚠️ Experimental: This project is currently in its early stages (version 0.x.x). The API and features may change as we refine and improve the plugin. We're actively seeking feedback from early adopters to help shape its development.

Features

• Create Gradle tasks that run operations inside containers.
• Declare containers as task inputs and outputs.

Getting Started

Add the plugin to your build.gradle.kts file:

plugins {
  id("dev.codebandits.container") version "<latest-version>"
}

Create tasks that use containers:

import dev.codebandits.container.gradle.tasks.ContainerRunTask

tasks {
  register<ContainerRunTask>("writeHello") {
    dockerRun {
      image = "alpine:latest"
      entrypoint = "sh"
      args = arrayOf("-c", "echo Hello from a container! > message.txt")
      workdir = "/workdir"
      volumes = arrayOf(
        "${layout.projectDirectory}:/workdir",
      )
    }
  }
}

To see more ways to use this plugin see the examples folder.

Contributing

We welcome contributions! Feel free to open an issue to discuss your ideas or share a pull request directly.

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Made by Code Bandits 🦅