chore: auto generated version file

Author: devnatan

.github/workflows/publish.yml

@@ -1,9 +1,8 @@
 name: Publish package
 
 on:
-  release:
-    types: [published]
-  workflow_dispatch:
+  push:
+    tags: [ 'v*.*.*' ]
 
 env:
   MAVEN_CENTRAL_USERNAME: ${{ secrets.OSSRH_USERNAME }}
@@ -16,7 +15,6 @@ jobs:
         runs-on: ubuntu-latest
         permissions:
             contents: read
-            packages: write
         steps:
             - name: Checkout Application Repository
               uses: actions/checkout@v4
@@ -33,7 +31,7 @@ jobs:
               uses: gradle/actions/setup-gradle@v4
 
             - name: Publish to Maven Central
-              run: ./gradlew publishAndReleaseToMavenCentral --no-daemon --stacktrace --no-configuration-cache
+              run: ./gradlew publishAndReleaseToMavenCentral -Pversion=${{ github.ref_name }} --no-daemon --stacktrace --no-configuration-cache
               env:
                   USERNAME: ${{ github.actor }}
                   TOKEN: ${{ secrets.GITHUB_TOKEN }}

…in/kotlin/InventoryFrameworkExtension.kt …conventions/src/main/kotlin/Extension.ktbuild-logic/conventions/src/main/kotlin/InventoryFrameworkExtension.kt renamed to build-logic/conventions/src/main/kotlin/Extension.kt build-logic/conventions/src/main/kotlin/InventoryFrameworkExtension.kt renamed to build-logic/conventions/src/main/kotlin/Extension.kt

@@ -6,4 +6,6 @@ import javax.inject.Inject
 abstract class InventoryFrameworkExtension @Inject constructor(objects: ObjectFactory) {
 
     val publish: Property<Boolean> = objects.property<Boolean>().convention(false)
+
+    val generateVersionFile: Property<Boolean> = objects.property<Boolean>().convention(false)
 }

build-logic/conventions/src/main/kotlin/GenerateVersionFileTask.kt

@@ -0,0 +1,61 @@
+import org.gradle.api.DefaultTask
+import org.gradle.api.Project
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.SourceSetContainer
+import org.gradle.api.tasks.TaskAction
+import org.gradle.kotlin.dsl.register
+import java.io.File
+
+internal abstract class GenerateVersionFileTask : DefaultTask() {
+
+    init {
+        group = "inventoryFramework"
+    }
+
+    @get:Input
+    abstract val version: Property<String>
+
+    @get:OutputDirectory
+    abstract val outputDir: DirectoryProperty
+
+    @TaskAction
+    fun generate() {
+        val packageDir = outputDir.get().dir("me/devnatan/inventoryframework/runtime").asFile
+        packageDir.mkdirs()
+
+        val file = File(packageDir, "InventoryFramework.java")
+        file.writeText(
+            """
+            package me.devnatan.inventoryframework.runtime;
+
+            import org.bukkit.plugin.java.JavaPlugin;
+
+            public final class InventoryFramework extends JavaPlugin {
+
+                public static final String LIBRARY_VERSION = "${version.get()}";
+            }
+            
+            """.trimIndent()
+        )
+    }
+}
+
+internal fun Project.registerGenerateVersionFileTask() {
+    val generateVersionFileTask = tasks.register<GenerateVersionFileTask>("generateVersionFile") {
+        version.set(project.version.toString())
+        outputDir.set(layout.buildDirectory.dir("generated/sources/ifversion"))
+    }
+
+    extensions.configure<SourceSetContainer>("sourceSets") {
+        named("main") {
+            java.srcDir(generateVersionFileTask.flatMap { it.outputDir })
+        }
+    }
+
+    tasks.named("compileJava") {
+        dependsOn(generateVersionFileTask)
+    }
+}

build-logic/conventions/src/main/kotlin/LibraryConventionPlugin.kt

@@ -11,7 +11,7 @@ import org.gradle.kotlin.dsl.create
 import org.gradle.kotlin.dsl.getByType
 import org.gradle.kotlin.dsl.withType
 
-class LibraryConventionPlugin : Plugin<Project> {
+internal class LibraryConventionPlugin : Plugin<Project> {
 
     override fun apply(target: Project) = with(target) {
         group = rootProject.group
@@ -23,8 +23,10 @@ class LibraryConventionPlugin : Plugin<Project> {
 
         val extension = project.extensions.create<InventoryFrameworkExtension>("inventoryFramework")
         project.afterEvaluate {
+            if (extension.generateVersionFile.get())
+                registerGenerateVersionFileTask()
+
             if (extension.publish.get()) {
-                plugins.apply("com.vanniktech.maven.publish.base")
                 configureInventoryFrameworkPublication()
             }
         }
@@ -50,6 +52,7 @@ class LibraryConventionPlugin : Plugin<Project> {
             java {
                 removeUnusedImports()
                 palantirJavaFormat()
+                targetExclude("build/generated/sources/ifversion/**/*.java")
             }
             kotlin {
                 ktfmt().kotlinlangStyle()

build-logic/conventions/src/main/kotlin/Publish.kt

@@ -3,7 +3,9 @@ import com.vanniktech.maven.publish.SonatypeHost
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.configure
 
-fun Project.configureInventoryFrameworkPublication() {
+internal fun Project.configureInventoryFrameworkPublication() {
+    plugins.apply("com.vanniktech.maven.publish.base")
+
     extensions.configure<MavenPublishBaseExtension> {
         publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL)
         signAllPublications()

inventory-framework-platform-bukkit/build.gradle.kts

@@ -1,6 +1,3 @@
-import com.vanniktech.maven.publish.JavaLibrary
-import com.vanniktech.maven.publish.JavadocJar
-
 plugins {
     id("me.devnatan.inventoryframework.library")
     alias(libs.plugins.shadowjar)
@@ -9,6 +6,7 @@ plugins {
 
 inventoryFramework {
     publish = true
+    generateVersionFile = true
 }
 
 dependencies {