Common configuration Gradle plugin

A Gradle plugin for sharing versioning and configuration across independent projects.

Report Bug · Request Feature · Changelog

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

This Gradle plugin injects some basic configuration (including dependencies and plugins) into all of your (unrelated to each other) projects from a shared, single point of declaration.

It was invented to help us get new project initialized faster and keep track of versions at a single place for all of our projects. It does also include some GitHub action blueprints.

Versioning strategy

This library uses Semantic Versioning 2.0 and generates its Changelog from Conventional Commit messages.

(back to top)

Getting Started

Prerequisites

We choose to support the lowest actively supported Java version at the time of writing, that is, Java 11 (this may be subject to change in future releases).

Usage

The config given in this repository already includes kotlin and the org.jetbrains.kotlin:kotlin-bom artifact in the latest version; so a minimal build.gradle.kts would look like:

// Complete [sic!] working example of build.gradle.kts

repositories {
    mavenCentral()
}

plugins {
    id("io.mailguru.gradle-config") version "1.0.2"
}

You may, of course, override the configuration of the injected dependencies and plugins on your own, e.g.:

// Complete [sic!] working example of build.gradle.kts

repositories {
    mavenCentral()
}

plugins {
    id("io.mailguru.gradle-config") version "1.0.2"
}

detekt {
    // Adds debug output during task execution. `false` by default.
    debug = true
}

The plugin will also add some output of the applied configuration to your Gradle tasks.

(back to top)

Contributing

Contributions are welcome; please stick to the GitHub Fork & Pull Request Workflow.
We will then review your changes and accept your PR if applicable.

(back to top)

License

Distributed under the GNU General Public License v3.0. See LICENSE.md for more information.

(back to top)

Contact

Project Link: https://github.com/mlgr-io/gradle-config

(back to top)