README.md

Cake.Gradle

Aliases to assist with running Gradle builds from Cake build scripts.

Table of Contents

• Install
• Usage
• Compatibility
• Motivation
• A Word of caution
• Discussion
• Maintainer
• Contributing
  • Contributors
• License
  • LitJson

Install

#addin nuget:?package=Cake.Gradle

Additionally, either gradle has to be installed on the system or the project needs a gradle-wrapper (gradlew)

Usage

 #addin nuget:?package=Cake.Gradle

// Run 'gradle --version'
Task("Gradle-Version")
    .Does(() =>
{
    Gradle.WithArguments("--version").Run();
});

// Run 'gradle hello' in a specific folder
// Note: if you have a gradle wrapper setup in the specified path, this one will be used
Task("Gradle-Hello")
    .Does(() =>
{
    Gradle.FromPath("./example").WithTask("hello").Run();
});


// Run 'gradle hello' in a specific folder with default log level
// Note: if no log level is set, it is derived from the Cake verbosity (which is set to 'verbose' in build.ps1)
Task("Gradle-Hello-WithDefaultLogLevel")
    .Does(() =>
{
    Gradle.FromPath("./example").WithTask("hello").WithLogLevel(GradleLogLevel.Default).Run(); 
});

// Run 'gradle --offline --build-file build.gradle hello' in a specific folder
Task("Gradle-Hello-WithArguments")
    .Does(() =>
{
    Gradle.FromPath("./example").WithTask("hello").WithArguments("--offline --build-file build.gradle").Run();
});

Compatibility

Cake 0.33.0 and later.

Motivation

Allow Cake users to orchestrate a complex build including a Gradle-based Java build. Works similar to the cake-gulp addin.

A Word of caution

Cake and Gradle are both task runners. I consider it bad practice to call one task runner out of another. It would be better to only have one tool per concern (i.e. task running) - but sometimes this is not feasible.

Discussion

For questions and to discuss ideas & feature requests, use the GitHub discussions on the Cake GitHub repository, under the Extension Q&A category.

Maintainer

Nils Andresen @nils-a

Contributing

Cake.Gradle follows the Contributor Covenant Code of Conduct.

We accept Pull Requests. Please see the contributing file for how to contribute to Cake.Gradle.

Small note: If editing the Readme, please conform to the standard-readme specification.

This project follows the all-contributors specification. Contributions of any kind welcome!

Contributors

Thanks goes to these wonderful people (emoji key):

Christian Abegg 💻

Nils Andresen 💻

License

MIT License © Christian Abegg, Nils Andresen

Cake.Gradle includes third-party code which is licensed under its own respective license.

LitJSON

License: Unlicense, https://github.com/LitJSON/litjson/blob/develop/COPYING