Add GH workflow & adjust build.gradle.kts for publishing to Maven central

Author: tobi-laa

.github/workflows/maven-publish.yml

@@ -0,0 +1,42 @@
+name: Publish package to the Maven Central Repository
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+      - name: Create GitHub Release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ github.event.release.tag_name }}
+          generateReleaseNotes: true
+      - name: Set up Java for publishing to Maven Central Repository
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          server-id: ossrh
+          server-username: OSSRH_USERNAME
+          server-password: OSSRH_TOKEN
+          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+          gpg-passphrase: GPG_PASSPHRASE
+      - name: Validate Gradle wrapper
+        uses: gradle/wrapper-validation-action@ccb4328a959376b642e027874838f60f8e596de3
+      - name: Publish package
+        uses: gradle/gradle-build-action@749f47bda3e44aa060e82d7b3ef7e40d953bd629
+        with:
+          arguments: publish
+        env:
+          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+          GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

build.gradle.kts

@@ -12,16 +12,21 @@ plugins {
 
     id("io.spring.dependency-management") version springDependencyManagementVersion
     kotlin("jvm") version kotlinVersion
+    id("java-library")
     id("com.adarshr.test-logger") version adarshrTestLoggerVersion
     id("jacoco")
     id("org.sonarqube") version sonarqubeVersion
+    id("maven-publish")
+    id("signing")
 }
 
-group = "io.github.tobi.laa"
+group = "io.github.tobi-laa"
 version = "0.0.1-SNAPSHOT"
 
 java {
     sourceCompatibility = JavaVersion.VERSION_17
+    withJavadocJar()
+    withSourcesJar()
 }
 
 sonar {
@@ -72,4 +77,79 @@ tasks.jacocoTestReport {
     reports {
         xml.required = true
     }
-}
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("mavenJava") {
+            groupId = "${group}"
+            artifactId = rootProject.name
+            version = version
+            from(components["java"])
+            versionMapping {
+                usage("java-api") {
+                    fromResolutionOf("runtimeClasspath")
+                }
+                usage("java-runtime") {
+                    fromResolutionResult()
+                }
+            }
+            pom {
+                name = "${group}:${rootProject.name}"
+                description = "Integrates embedded-redis with Spring Boot"
+                url = "https://github.com/tobias-laa/spring-boot-embedded-redis.git"
+                properties = mapOf(
+                    "myProp" to "value",
+                    "prop.with.dots" to "anotherValue"
+                )
+                licenses {
+                    license {
+                        name = "The Apache License, Version 2.0"
+                        url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
+                        distribution = "repo"
+                        comments = "A business-friendly OSS license"
+                    }
+                }
+                developers {
+                    developer {
+                        id = "tobi-laa"
+                        name = "Tobias Laatsch"
+                        email = "tobias.laatsch@posteo.de"
+                        organizationUrl = "https://github.com/tobias-laa"
+                    }
+                }
+                scm {
+                    connection = "scm:git:git@github.com:tobias-laa/spring-boot-embedded-redis.git"
+                    developerConnection = "scm:git:git@github.com:tobias-laa/spring-boot-embedded-redis.git"
+                    url = "https://github.com/tobias-laa/spring-boot-embedded-redis/tree/master"
+                    tag = "HEAD"
+                }
+                issueManagement {
+                    system = "GitHub Issues"
+                    url = "https://github.com/tobias-laa/spring-boot-embedded-redis/issues"
+                }
+                inceptionYear = "2024"
+            }
+        }
+    }
+    repositories {
+        maven {
+            name = "OSSRH"
+            val releasesRepoUrl = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
+            val snapshotsRepoUrl = uri("https://oss.sonatype.org/content/repositories/snapshots")
+            url = if (version.toString().endsWith("SNAPSHOT")) snapshotsRepoUrl else releasesRepoUrl
+            credentials {
+                username = System.getenv("MAVEN_USERNAME")
+                password = System.getenv("MAVEN_PASSWORD")
+            }
+        }
+    }
+}
+
+signing {
+    sign(publishing.publications["mavenJava"])
+}
+
+tasks.javadoc {
+    (options as StandardJavadocDocletOptions).addBooleanOption("html5", true)
+}