Publish to Maven Central (#319)

Author: mickael-menu

.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+# Inspired by https://getstream.io/blog/publishing-libraries-to-mavencentral-2021/
+name: Publish
+
+on:
+  workflow_dispatch:
+  release:
+    types: [ released ]
+
+jobs:
+  publish:
+    name: Publish to Maven Central
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          ref: develop
+      - name: Set up JDK 11
+        uses: actions/setup-java@v2
+        with:
+          distribution: adopt
+          java-version: 11
+
+        # Builds the release artifacts of the library
+      - name: Release build
+        run: ./gradlew assembleRelease
+
+        # Generates other artifacts (javadocJar is optional)
+      - name: Source jar and dokka
+        run: ./gradlew androidSourcesJar javadocJar
+
+        # Runs upload, and then closes & releases the repository
+      - name: Publish to Maven Central
+        run: ./gradlew publishReleasePublicationToSonatypeRepository --max-workers 1 closeAndReleaseSonatypeStagingRepository
+        env:
+          OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
+          SIGNING_KEY_ID: ${{ secrets.SIGNING_KEY_ID }}
+          SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
+          SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
+          SONATYPE_STAGING_PROFILE_ID: ${{ secrets.SONATYPE_STAGING_PROFILE_ID }}
+

README.md

@@ -25,7 +25,7 @@ A [Test App](test-app) demonstrates how to integrate the Readium Kotlin toolkit
 
 ## Setting Up Readium
 
-Readium modules are distributed through [JitPack](https://jitpack.io/#readium/kotlin-toolkit). Make sure that you have the `$readium_version` property set in your root `build.gradle`, then add the JitPack and JCenter repositories.
+Readium modules are distributed with [Maven Central](https://search.maven.org/search?q=g:org.readium.kotlin-toolkit). Make sure that you have the `$readium_version` property set in your root `build.gradle`, then add the Maven Central and JCenter repositories.
 
 ```groovy
 buildscript {
@@ -35,7 +35,7 @@ buildscript {
 allprojects {
     repositories {
         jcenter()
-        maven { url 'https://jitpack.io' }
+        mavenCentral()
     }
 }
 ```
@@ -44,11 +44,11 @@ Then, add the dependencies to the Readium modules you need in your app's `build.
 
 ```groovy
 dependencies {
-    implementation "com.github.readium.kotlin-toolkit:readium-shared:$readium_version"
-    implementation "com.github.readium.kotlin-toolkit:readium-streamer:$readium_version"
-    implementation "com.github.readium.kotlin-toolkit:readium-navigator:$readium_version"
-    implementation "com.github.readium.kotlin-toolkit:readium-opds:$readium_version"
-    implementation "com.github.readium.kotlin-toolkit:readium-lcp:$readium_version"
+    implementation "org.readium.kotlin-toolkit:readium-shared:$readium_version"
+    implementation "org.readium.kotlin-toolkit:readium-streamer:$readium_version"
+    implementation "org.readium.kotlin-toolkit:readium-navigator:$readium_version"
+    implementation "org.readium.kotlin-toolkit:readium-opds:$readium_version"
+    implementation "org.readium.kotlin-toolkit:readium-lcp:$readium_version"
 }
 ```
 

build.gradle.kts

@@ -9,25 +9,20 @@ import org.jetbrains.dokka.gradle.DokkaTaskPartial
 plugins {
     id("com.android.application") apply false
     id("com.android.library") apply false
-    id("org.jetbrains.kotlin.android") apply false
+    id("io.github.gradle-nexus.publish-plugin") apply true
     id("org.jetbrains.dokka") apply true
+    id("org.jetbrains.kotlin.android") apply false
     id("org.jlleitschuh.gradle.ktlint") apply true
 }
 
-allprojects {
-    group = "com.github.readium.kotlin-toolkit"
+apply(from = "$rootDir/scripts/publish-root.gradle")
+
+ext {
+    set("publish.groupId", "org.readium.kotlin-toolkit")
+    set("publish.version", "2.3.0")
 }
 
 subprojects {
-    tasks.register<Jar>("javadocsJar") {
-        archiveClassifier.set("javadoc")
-    }
-
-    tasks.register<Jar>("sourcesJar") {
-        archiveClassifier.set("sources")
-        from("src/main/java", "src/main/resources")
-    }
-
     apply(plugin = "org.jlleitschuh.gradle.ktlint")
 
     ktlint {

docs/migration-guide.md

@@ -2,6 +2,33 @@
 
 All migration steps necessary in reading apps to upgrade to major versions of the Kotlin Readium toolkit will be documented in this file.
 
+## Unreleased
+
+### Maven Central
+
+Readium is now distributed with [Maven Central](https://search.maven.org/search?q=g:org.readium.kotlin-toolkit). You must update your Gradle configuration.
+
+```diff
+allprojects {
+    repositories {
+-       maven { url 'https://jitpack.io' }
++       mavenCentral()
+    }
+}
+```
+
+The group ID of the Readium modules is now `org.readium.kotlin-toolkit`, for instance:
+
+```groovy
+dependencies {
+    implementation "org.readium.kotlin-toolkit:readium-shared:$readium_version"
+    implementation "org.readium.kotlin-toolkit:readium-streamer:$readium_version"
+    implementation "org.readium.kotlin-toolkit:readium-navigator:$readium_version"
+    implementation "org.readium.kotlin-toolkit:readium-opds:$readium_version"
+    implementation "org.readium.kotlin-toolkit:readium-lcp:$readium_version"
+}
+```
+
 ## 2.3.0
 
 ### `Decoration.extras`

readium/adapters/pdfium/build.gradle.kts

@@ -8,8 +8,6 @@ plugins {
     id("com.android.library")
     kotlin("android")
     kotlin("plugin.parcelize")
-    id("maven-publish")
-    id("org.jetbrains.dokka")
 }
 
 android {
@@ -42,20 +40,8 @@ android {
     namespace = "org.readium.adapters.pdfium"
 }
 
-publishing {
-    publications {
-        create<MavenPublication>("release") {
-            groupId = "com.github.readium"
-            artifactId = "readium-adapter-pdfium"
-            artifact(tasks.findByName("sourcesJar"))
-            artifact(tasks.findByName("javadocsJar"))
-
-            afterEvaluate {
-                from(components.getByName("release"))
-            }
-        }
-    }
-}
+rootProject.ext["publish.artifactId"] = "readium-adapter-pdfium"
+apply(from = "$rootDir/scripts/publish-module.gradle")
 
 dependencies {
     api(project(":readium:adapters:pdfium:readium-adapter-pdfium-document"))

readium/adapters/pdfium/pdfium-document/build.gradle.kts

@@ -8,8 +8,6 @@ plugins {
     id("com.android.library")
     kotlin("android")
     kotlin("plugin.parcelize")
-    id("maven-publish")
-    id("org.jetbrains.dokka")
 }
 
 android {
@@ -45,20 +43,8 @@ android {
     namespace = "org.readium.adapters.pdfium.document"
 }
 
-publishing {
-    publications {
-        create<MavenPublication>("release") {
-            groupId = "com.github.readium"
-            artifactId = "readium-adapter-pdfium-document"
-            artifact(tasks.findByName("sourcesJar"))
-            artifact(tasks.findByName("javadocsJar"))
-
-            afterEvaluate {
-                from(components.getByName("release"))
-            }
-        }
-    }
-}
+rootProject.ext["publish.artifactId"] = "readium-adapter-pdfium-document"
+apply(from = "$rootDir/scripts/publish-module.gradle")
 
 dependencies {
     api(project(":readium:readium-shared"))

readium/adapters/pdfium/pdfium-navigator/build.gradle.kts

@@ -9,8 +9,6 @@ plugins {
     kotlin("android")
     kotlin("plugin.parcelize")
     kotlin("plugin.serialization")
-    id("maven-publish")
-    id("org.jetbrains.dokka")
 }
 
 android {
@@ -46,20 +44,8 @@ android {
     namespace = "org.readium.adapters.pdfium.navigator"
 }
 
-publishing {
-    publications {
-        create<MavenPublication>("release") {
-            groupId = "com.github.readium"
-            artifactId = "readium-adapter-pdfium-navigator"
-            artifact(tasks.findByName("sourcesJar"))
-            artifact(tasks.findByName("javadocsJar"))
-
-            afterEvaluate {
-                from(components.getByName("release"))
-            }
-        }
-    }
-}
+rootProject.ext["publish.artifactId"] = "readium-adapter-pdfium-navigator"
+apply(from = "$rootDir/scripts/publish-module.gradle")
 
 dependencies {
     api(project(":readium:readium-shared"))

readium/adapters/pspdfkit/build.gradle.kts

@@ -8,8 +8,6 @@ plugins {
     id("com.android.library")
     kotlin("android")
     kotlin("plugin.parcelize")
-    id("maven-publish")
-    id("org.jetbrains.dokka")
 }
 
 android {
@@ -42,20 +40,8 @@ android {
     namespace = "org.readium.adapters.pspdfkit"
 }
 
-publishing {
-    publications {
-        create<MavenPublication>("release") {
-            groupId = "com.github.readium"
-            artifactId = "readium-adapter-pspdfkit"
-            artifact(tasks.findByName("sourcesJar"))
-            artifact(tasks.findByName("javadocsJar"))
-
-            afterEvaluate {
-                from(components.getByName("release"))
-            }
-        }
-    }
-}
+rootProject.ext["publish.artifactId"] = "readium-adapter-pspdfkit"
+apply(from = "$rootDir/scripts/publish-module.gradle")
 
 dependencies {
     api(project(":readium:adapters:pspdfkit:readium-adapter-pspdfkit-document"))

readium/adapters/pspdfkit/pspdfkit-document/build.gradle.kts

@@ -8,8 +8,6 @@ plugins {
     id("com.android.library")
     kotlin("android")
     kotlin("plugin.parcelize")
-    id("maven-publish")
-    id("org.jetbrains.dokka")
 }
 
 android {
@@ -45,20 +43,8 @@ android {
     namespace = "org.readium.adapters.pspdfkit.document"
 }
 
-publishing {
-    publications {
-        create<MavenPublication>("release") {
-            groupId = "com.github.readium"
-            artifactId = "readium-adapter-pspdfkit-document"
-            artifact(tasks.findByName("sourcesJar"))
-            artifact(tasks.findByName("javadocsJar"))
-
-            afterEvaluate {
-                from(components.getByName("release"))
-            }
-        }
-    }
-}
+rootProject.ext["publish.artifactId"] = "readium-adapter-pspdfkit-document"
+apply(from = "$rootDir/scripts/publish-module.gradle")
 
 dependencies {
     api(project(":readium:readium-shared"))

readium/adapters/pspdfkit/pspdfkit-navigator/build.gradle.kts

@@ -9,8 +9,6 @@ plugins {
     kotlin("android")
     kotlin("plugin.parcelize")
     kotlin("plugin.serialization")
-    id("maven-publish")
-    id("org.jetbrains.dokka")
 }
 
 android {
@@ -46,20 +44,8 @@ android {
     namespace = "org.readium.adapters.pspdfkit.navigator"
 }
 
-publishing {
-    publications {
-        create<MavenPublication>("release") {
-            groupId = "com.github.readium"
-            artifactId = "readium-adapter-pspdfkit-navigator"
-            artifact(tasks.findByName("sourcesJar"))
-            artifact(tasks.findByName("javadocsJar"))
-
-            afterEvaluate {
-                from(components.getByName("release"))
-            }
-        }
-    }
-}
+rootProject.ext["publish.artifactId"] = "readium-adapter-pspdfkit-navigator"
+apply(from = "$rootDir/scripts/publish-module.gradle")
 
 dependencies {
     api(project(":readium:readium-shared"))

readium/lcp/build.gradle.kts

@@ -9,8 +9,6 @@ plugins {
     kotlin("android")
     kotlin("plugin.parcelize")
     kotlin("kapt")
-    id("maven-publish")
-    id("org.jetbrains.dokka")
 }
 
 android {
@@ -42,20 +40,8 @@ android {
     namespace = "org.readium.r2.lcp"
 }
 
-publishing {
-    publications {
-        create<MavenPublication>("release") {
-            groupId = "com.github.readium"
-            artifactId = "readium-lcp"
-            artifact(tasks.findByName("sourcesJar"))
-            artifact(tasks.findByName("javadocsJar"))
-
-            afterEvaluate {
-                from(components.getByName("release"))
-            }
-        }
-    }
-}
+rootProject.ext["publish.artifactId"] = "readium-lcp"
+apply(from = "$rootDir/scripts/publish-module.gradle")
 
 dependencies {
     implementation(libs.kotlinx.coroutines.core)