How theaniketraj/vista works
Project Type & Purpose
• Type: A CLI Gradle plugin (VISTA) plus a sample Android app (“app” module) demonstrating its usage.
• Purpose: Automate semantic version increments via a version.properties file, integrate with Gradle build lifecycle, and publish to the Gradle Plugin Portal.
File Structure
Top-level elements
├─ settings.gradle.kts & Gradle Wrapper (gradlew, gradle/) – orchestrate multi-module build
├─ version.properties – central version store
├─ app/ – Android sample applying the plugin
├─ vista-plugin/ – plugin implementation and publishing config
└─ .github/workflows/vista-plugin.yml – CI pipeline definition
Key patterns
• Multi-module Gradle project
• Plugin extension points (Gradle Plugin Publish DSL + META-INF descriptors)
• CLI task entrypoint (incrementVersion)
Extract Insights from the README
• Core component: com.example.vista.VersioningPlugin class
• Main tasks: incrementVersion
• Publishing metadata under META-INF/gradle-plugins/
• CI integration via GitHub Actions to build, test, and publish
A. Developer Workstation
– Runs ./gradlew <task> via the Gradle Wrapper
B. Gradle Wrapper & Settings
– bootstraps Gradle, loads modules, resolves plugins
C. Plugin Module (vista-plugin)
– Contains VersioningPlugin.kt
– Descriptor in META-INF/gradle-plugins/com.example.vista.versioning.properties
– Implements Gradle’s Plugin<Project> interface
D. version.properties File
– Holds VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH, BUILD_NUMBER
– Read/write by incrementVersion task
E. Sample Android App Module (app)
– Applies com.example.vista.versioning plugin
– Triggers version increment during its build lifecycle
F. CI/CD Pipeline (GitHub Actions)
– Triggers on push/tags
– Executes ./gradlew build publishPlugin
G. Gradle Plugin Portal (External Service)
– Receives published plugin artifacts via Gradle Plugin Publish
Architectural Patterns & Design Principles
• Modularization: separate plugin logic (vista-plugin) from sample consumer (app)
• Plugin Pattern: implements Gradle’s plugin contract, defines tasks and extensions
• Configuration-as-Code: uses version.properties, Gradle DSL, and META-INF descriptors
• CI/CD Pipeline: declarative build/test/publish steps in GitHub Actions
Essential Elements
• Clear component names (e.g., VersioningPlugin, version.properties)
• Annotations for key technologies (Kotlin, Gradle, GitHub Actions)