Prepare Gradle plugin publishing

Author: egorikftp

.github/workflows/gradle-plugin-release.yml

@@ -1 +1,49 @@
+name: Publish Gradle Plugin
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      GRADLE_PUBLISH_KEY: ${{ secrets.ORG_GRADLE_PUBLISH_KEY }}
+      GRADLE_PUBLISH_SECRET: ${{ secrets.ORG_GRADLE_PUBLISH_SECRET }}
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup Java
+        uses: actions/setup-java@v5
+        with:
+          distribution: temurin
+          java-version: 21
+
+      - name: Prepare release information
+        run: |
+          VERSION_NAME=$(grep "^gradle-plugin-version" gradle/gradle.versions.toml | cut -d '"' -f 2)
+          RELEASE_TAG="gradle-plugin-$VERSION_NAME"
+
+          echo "VERSION_NAME=$VERSION_NAME"
+          echo "RELEASE_TAG=$RELEASE_TAG"
+
+          echo "VERSION_NAME=$VERSION_NAME" >> $GITHUB_ENV
+          echo "RELEASE_TAG=$RELEASE_TAG" >> $GITHUB_ENV
+
+      - name: Validate Plugin
+        run: ./gradlew :tools:gradle-plugin:validatePlugins
+
+      - name: Publish to Gradle Plugin Portal
+        run: |
+          ./gradlew :tools:gradle-plugin:publishPlugins \
+            -Pgradle.publish.key="${GRADLE_PUBLISH_KEY}" \
+            -Pgradle.publish.secret="${GRADLE_PUBLISH_SECRET}"
+
+      - name: Create GitHub release
+        run: |
+          gh release create ${{ env.RELEASE_TAG }} --generate-notes
 

DEVELOPMENT.md

@@ -40,6 +40,10 @@ Update changelog with new version: `./gradlew patchChangelog`
 
 Build CLI: `./gradlew buildCLI`
 
+## Gradle Plugin
+
+Test plugin locally: `./gradlew :tools:gradle-plugin:publishToMavenLocal`
+
 ## WEB
 
 - Run WASM: `./gradlew tools:compose-app:wasmJsBrowserDevelopmentRun`

gradle/gradle.versions.toml

@@ -0,0 +1,12 @@
+[versions]
+gradle-plugin-version = "0.1.0"
+
+agp = "8.13.1"
+
+[libraries]
+agp-api = { module = "com.android.tools.build:gradle-api", version.ref = "agp" }
+agp-full = { module = "com.android.tools.build:gradle", version.ref = "agp" }
+
+[plugins]
+plugin-publish = { id = "com.gradle.plugin-publish", version = "2.0.0" }
+

gradle/libs.versions.toml

@@ -39,9 +39,6 @@ semver = "net.swiftzer.semver:semver:2.1.0"
 ktlint = "com.pinterest.ktlint:ktlint-cli:1.8.0"
 composeRules = "io.nlopez.compose.rules:ktlint:0.4.28"
 
-agp-api = { module = "com.android.tools.build:gradle-api", version.ref = "agp" }
-agp-full = { module = "com.android.tools.build:gradle", version.ref = "agp" }
-
 # Dependencies for build-logic module
 kotlin-compose-compiler-plugin = { module = "org.jetbrains.kotlin:compose-compiler-gradle-plugin", version.ref = "kotlin" }
 kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }

settings.gradle.kts

@@ -45,6 +45,9 @@ dependencyResolutionManagement {
             create("cli") {
                 from(files("gradle/cli.versions.toml"))
             }
+            create("gradlePluginVersions") {
+                from(files("gradle/gradle.versions.toml"))
+            }
         }
     }
 }

tools/gradle-plugin/build.gradle.kts

@@ -9,21 +9,13 @@ plugins {
     alias(libs.plugins.valkyrie.kover)
     alias(libs.plugins.valkyrie.abi)
     alias(libs.plugins.buildconfig)
+    alias(libs.plugins.shadow)
+    alias(gradlePluginVersions.plugins.plugin.publish)
     `java-gradle-plugin`
 }
 
-tasks.validatePlugins {
-    // TODO: https://github.com/gradle/gradle/issues/22600
-    enableStricterValidation = true
-}
-
-kotlin {
-    compilerOptions {
-        // https://docs.gradle.org/current/userguide/compatibility.html#kotlin
-        apiVersion = KotlinVersion.KOTLIN_2_2
-        languageVersion = apiVersion
-    }
-}
+group = "io.github.composegears.valkyrie"
+version = gradlePluginVersions.versions.gradle.plugin.version.get()
 
 gradlePlugin {
     vcsUrl = "https://github.com/ComposeGears/Valkyrie"
@@ -32,13 +24,29 @@ gradlePlugin {
     plugins {
         create("valkyrie") {
             id = "io.github.composegears.valkyrie"
-            displayName = name
+            displayName = "Valkyrie Gradle Plugin"
             implementationClass = "io.github.composegears.valkyrie.gradle.ValkyrieGradlePlugin"
-            description = "Generates Kotlin accessors for ImageVectors, based on input SVG files"
-            tags.addAll("kotlin", "svg", "xml", "imagevector", "valkyrie")
+            description = "Convert SVG/XML icons into Compose ImageVector format"
+            tags.addAll("kotlin", "svg", "xml", "imagevector", "valkyrie", "compose")
         }
     }
 }
+kotlin {
+    compilerOptions {
+        // https://docs.gradle.org/current/userguide/compatibility.html#kotlin
+        apiVersion = KotlinVersion.KOTLIN_2_2
+        languageVersion = apiVersion
+    }
+}
+
+tasks.validatePlugins {
+    // TODO: https://github.com/gradle/gradle/issues/22600
+    enableStricterValidation = true
+}
+
+tasks.shadowJar {
+    archiveClassifier = ""
+}
 
 configurations.named(API_ELEMENTS_CONFIGURATION_NAME) {
     attributes.attribute(
@@ -82,19 +90,19 @@ tasks.pluginUnderTestMetadata {
 }
 
 dependencies {
-    compileOnly(libs.agp.api)
+    compileOnly(gradlePluginVersions.agp.api)
     compileOnly(libs.kotlin.gradle.plugin)
 
-    api(projects.sdk.core.extensions)
-    api(projects.sdk.ir.core)
-    api(projects.components.generator.iconpack)
-    api(projects.components.generator.jvm.imagevector)
-    api(projects.components.parser.unified)
+    implementation(projects.sdk.core.extensions)
+    implementation(projects.sdk.ir.core)
+    implementation(projects.components.generator.iconpack)
+    implementation(projects.components.generator.jvm.imagevector)
+    implementation(projects.components.parser.unified)
 
     testImplementation(libs.bundles.test)
     testRuntimeOnly(libs.junit.launcher)
 
-    testPluginClasspath(libs.agp.full)
+    testPluginClasspath(gradlePluginVersions.agp.full)
     testPluginClasspath(libs.kotlin.gradle.plugin)
 }