gradle-review

Review Gradle build logic diffs for Spine conventions and best practices.

2|3|Updated Jun 5, 2018
One-click install
npx skills add https://github.com/SpineEventEngine/config --skill gradle-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gradle-review
Source: https://github.com/SpineEventEngine/config/tree/main/.agents/skills/gradle-review
Command: npx skills add https://github.com/SpineEventEngine/config --skill gradle-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents Gradle build failures and performance/correctness regressions by reviewing Gradle task and plugin code for compliance with Spine and upstream best practices.

Core Features & Use Cases

  • Spine Gradle task conformance checks: verifies every custom task sets group = "spine" and a correct imperative description.
  • Upstream Gradle best-practice enforcement: flags correctness-breaking patterns (e.g., Provider.get() during configuration, eager FileCollection/Configuration resolution, wrong output wiring).
  • Focused read-only review scopes: covers config repository buildSrc/ (with a carve-out for module.gradle.kts), Gradle scripts in the consuming project, and production code for Gradle plugins.
  • Use Case: After you change build logic or add/update a Gradle plugin task, run this review to ensure tasks are cacheable, lazily configured, and correctly wired before you open a PR.

Quick Start

Run the gradle-review skill against your staged diff to get a categorized report of Must fix, Should fix, and Nit findings.

Frequently Asked Questions about gradle-review

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

FAQPage Schema
How do I check Gradle build scripts for configuration cache compatibility before a PR?

Gradle build logic review checks task and plugin code diffs against Spine SDK conventions and upstream best practices. It enforces required task metadata, flags eager resolution patterns, and reports categorized findings without running builds.

What Gradle task conventions should custom plugin tasks follow?

Custom Gradle plugin tasks should set `group = "spine"` and include a correct imperative `description`. This review verifies every custom task meets these metadata requirements to ensure build logic conformance before you open a PR.

Why does calling Provider.get() during configuration break Gradle builds?

Calling Provider.get() during configuration forces eager resolution, breaking Gradle's lazy evaluation and configuration cache. This review flags such correctness-breaking patterns in buildSrc and plugin code diffs to prevent performance regressions.

Does this Gradle build logic review cover buildSrc and plugin production code?

Yes, the review scopes across `buildSrc/` distributed configuration code, project Gradle scripts, and Gradle plugin production code. It applies specifically to diffs that register or configure tasks, excluding `module.gradle.kts` by default.

Can I review Gradle task wiring without executing the build?

Yes, the review analyzes staged diffs statically to report Must fix, Should fix, and Nit findings with file and line citations. It detects incorrect output wiring and convention violations without executing the build.

When should I avoid running a Gradle build logic review?

You should avoid running a Gradle build logic review when your changes do not touch Gradle build scripts, `buildSrc/`, or plugin task registration code. The review is focused exclusively on Gradle-related diffs and will not analyze unrelated source code.