Merge pull request #34 from pahill/readme_update

Update template to improve developer experience

Author: pahill

.github/workflows/deploy.yml

@@ -0,0 +1,25 @@
+name: Publish
+on:
+  release:
+    types: [released, prereleased]
+jobs:
+  publish:
+    name: Release build and publish
+    runs-on: macOS-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: 21
+      - name: Publish to MavenCentral
+        run: ./gradlew publishToMavenCentral --no-configuration-cache
+        env:
+          ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
+          ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
+          ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
+          ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
+          ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_KEY_CONTENTS }}
+

.github/workflows/publish.yml

@@ -8,4 +8,6 @@ captures
 .cxx
 local.properties
 xcuserdata
-.kotlin
+.kotlin
+#So we don't accidentally commit our private keys
+*.gpg

.gitignore

@@ -1,6 +1,5 @@
 plugins {
-    id("root.publication")
-    //trick: for the same plugin versions in all sub-modules
-    alias(libs.plugins.androidLibrary).apply(false)
-    alias(libs.plugins.kotlinMultiplatform).apply(false)
-}
+    alias(libs.plugins.androidLibrary) apply false
+    alias(libs.plugins.kotlinMultiplatform) apply  false
+    alias(libs.plugins.vanniktech.mavenPublish) apply false
+}

README.md

@@ -1,14 +1,13 @@
 [versions]
 agp = "8.5.0"
-kotlin = "2.0.0"
-nexus-publish = "2.0.0"
+kotlin = "2.0.20"
 android-minSdk = "24"
 android-compileSdk = "34"
 
 [libraries]
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
-nexus-publish = { module = "io.github.gradle-nexus.publish-plugin:io.github.gradle-nexus.publish-plugin.gradle.plugin", version.ref = "nexus-publish" }
 
 [plugins]
 androidLibrary = { id = "com.android.library", version.ref = "agp" }
-kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
+kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
+vanniktech-mavenPublish = { id = "com.vanniktech.maven.publish", version = "0.29.0" }

build.gradle.kts

@@ -1,12 +1,16 @@
+import com.vanniktech.maven.publish.SonatypeHost
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
 plugins {
     alias(libs.plugins.kotlinMultiplatform)
     alias(libs.plugins.androidLibrary)
-    id("module.publication")
+    alias(libs.plugins.vanniktech.mavenPublish)
 }
 
+group = "io.github.kotlin"
+version = "1.0.0"
+
 kotlin {
     jvm()
     androidTarget {
@@ -42,3 +46,37 @@ android {
         minSdk = libs.versions.android.minSdk.get().toInt()
     }
 }
+
+mavenPublishing {
+    publishToMavenCentral(SonatypeHost.CENTRAL_PORTAL)
+
+    signAllPublications()
+
+    coordinates(group.toString(), "library", version.toString())
+
+    pom {
+        name = "My library"
+        description = "A library."
+        inceptionYear = "2024"
+        url = "https://github.com/kotlin/multiplatform-library-template/"
+        licenses {
+            license {
+                name = "XXX"
+                url = "YYY"
+                distribution = "ZZZ"
+            }
+        }
+        developers {
+            developer {
+                id = "XXX"
+                name = "YYY"
+                url = "ZZZ"
+            }
+        }
+        scm {
+            url = "XXX"
+            connection = "YYY"
+            developerConnection = "ZZZ"
+        }
+    }
+}

convention-plugins/build.gradle.kts

@@ -1,2 +1,4 @@
+package io.github.kotlin.fibonacci
+
 actual val firstElement: Int = 1
 actual val secondElement: Int = 2

convention-plugins/settings.gradle.kts

@@ -1,10 +1,12 @@
+package io.github.kotlin.fibonacci
+
 import kotlin.test.Test
 import kotlin.test.assertEquals
 
 class AndroidFibiTest {
 
     @Test
     fun `test 3rd element`() {
-        assertEquals(3, fibi.take(3).last())
+        assertEquals(3, generateFibi().take(3).last())
     }
 }

convention-plugins/src/main/kotlin/module.publication.gradle.kts

@@ -1,4 +1,6 @@
-val fibi = sequence {
+package io.github.kotlin.fibonacci
+
+fun generateFibi() = sequence {
     var a = firstElement
     yield(a)
     var b = secondElement

convention-plugins/src/main/kotlin/root.publication.gradle.kts

@@ -1,10 +1,12 @@
+package io.github.kotlin.fibonacci
+
 import kotlin.test.Test
 import kotlin.test.assertEquals
 
 class FibiTest {
 
     @Test
     fun `test 3rd element`() {
-        assertEquals(firstElement + secondElement, fibi.take(3).last())
+        assertEquals(firstElement + secondElement, generateFibi().take(3).last())
     }
 }

gradle/libs.versions.toml

@@ -1,2 +1,4 @@
+package io.github.kotlin.fibonacci
+
 actual val firstElement: Int = 3
 actual val secondElement: Int = 4

images/create_release_and_tag.png

@@ -1,10 +1,12 @@
+package io.github.kotlin.fibonacci
+
 import kotlin.test.Test
 import kotlin.test.assertEquals
 
 class IosFibiTest {
 
     @Test
     fun `test 3rd element`() {
-        assertEquals(7, fibi.take(3).last())
+        assertEquals(7, generateFibi().take(3).last())
     }
 }

images/draft_release.png

@@ -1,2 +1,4 @@
+package io.github.kotlin.fibonacci
+
 actual val firstElement: Int = 2
 actual val secondElement: Int = 3

images/github_releases.png

@@ -1,10 +1,12 @@
+package io.github.kotlin.fibonacci
+
 import kotlin.test.Test
 import kotlin.test.assertEquals
 
 class JvmFibiTest {
 
     @Test
     fun `test 3rd element`() {
-        assertEquals(5, fibi.take(3).last())
+        assertEquals(5, generateFibi().take(3).last())
     }
 }

images/github_secrets.png

@@ -1,2 +1,4 @@
+package io.github.kotlin.fibonacci
+
 actual val firstElement: Int = 3
 actual val secondElement: Int = 5

images/published_on_maven_central.png

@@ -1,10 +1,12 @@
+package io.github.kotlin.fibonacci
+
 import kotlin.test.Test
 import kotlin.test.assertEquals
 
 class LinuxFibiTest {
 
     @Test
     fun `test 3rd element`() {
-        assertEquals(8, fibi.take(3).last())
+        assertEquals(8, generateFibi().take(3).last())
     }
 }