gradle-convention-plugin

Centralizes Gradle build logic for multi-module Java/Kotlin projects via Kotlin DSL conventions.

Updated Jan 23, 2025
One-click install
npx skills add https://github.com/ymkz/demo-monorepo --skill gradle-convention-plugin-ymkz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gradle-convention-plugin
Source: https://github.com/ymkz/demo-monorepo/tree/main/.agents/skills/gradle-convention-plugin
Command: npx skills add https://github.com/ymkz/demo-monorepo --skill gradle-convention-plugin-ymkz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Centralizes Gradle build logic as a shared convention to eliminate duplication across a multi-module project.

Core Features & Use Cases

  • Centralized conventions: common build logic for plugins, toolchains, and formatting across subprojects.
  • Modular integration: enables clean inclusion in subprojects via a single plugin reference.
  • Real-world scenario: apply consistent Gradle settings across apps/core and apps/api to ensure uniform builds.

Quick Start

Apply the gradle-convention-plugin in your root project to share common build configurations across modules.

Frequently Asked Questions about gradle-convention-plugin

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I centralize Gradle build logic to avoid duplication in a multi-module project?

To centralize Gradle build logic, apply a convention plugin in your root project to share common configurations for plugins, toolchains, and coding standards across subprojects. This eliminates duplicated build scripts.

What is the best way to share Kotlin DSL conventions across multiple Gradle subprojects?

Sharing Kotlin DSL conventions across Gradle subprojects is best achieved by using a convention plugin. It enables clean inclusion of shared build logic via a single plugin reference in each module.

Can I apply consistent Gradle settings across apps/core and apps/api modules?

Yes, you can apply consistent Gradle settings across apps/core and apps/api modules by applying a centralized convention plugin. This ensures uniform builds and shared toolchain configurations throughout the project.

How do I set up a Gradle convention plugin with a conventional project layout?

Setting up a Gradle convention plugin involves applying it in your root project to establish a conventional project layout. It provides setup guidance and example configurations for Kotlin DSL integration.

Do I need a convention plugin for my multi-module Java or Kotlin project?

You need a convention plugin for your multi-module Java or Kotlin project when you require shared conventions for plugins, toolchains, and formatting. It standardizes build automation across all modules.

Why does my multi-module Gradle build have inconsistent toolchain configurations?

Inconsistent toolchain configurations in a multi-module Gradle build happen when subprojects manage their own setups. Applying a centralized convention plugin enforces uniform toolchain and coding standards.