Merge pull request #32 from guardian/ab/publishing/use-nexus-plugin-t…

…o-auto-release

Add nexus gradle publish plugin to auto close staging and release

.github/workflows/release.yml

@@ -26,4 +26,4 @@ jobs:
             AUTOMATED_MAVEN_RELEASE_SONATYPE_PASSWORD: ${{ secrets.AUTOMATED_MAVEN_RELEASE_SONATYPE_PASSWORD }}
           run: |
             cd android
-            ./gradlew :source:publishAllPublicationsToSonatypeRepository
+            ./gradlew :source:publishToSonatype closeAndReleaseSonatypeStagingRepository

android/README.md

@@ -2,12 +2,9 @@
 
 # The Source library for Android
 
-> [!Note]
-> ~~This is an exploratory project as we evolve Source to support the apps, and the accompanying code infra.~~
-
 ### Using the library
 
-Add the library dependency:
+The library is available on Maven Central. Add the library dependency to your `build.gradle.kts` file:
 
 ```kotlin
 implementation("com.gu.source:source-android:0.0.1")
@@ -17,8 +14,6 @@ See the main [README](../README.md) for using the library.
 
 ### Building and using as a bundled repo
 
-~~Please note: This is a temporary solution until we publish the library to mavencentral~~
-
 1. Build the library
    Run
    ```shell
@@ -32,6 +27,27 @@ See the main [README](../README.md) for using the library.
 3. Update the version number in the news app
    If the library version has changed, update it in the version catalog for the news app.
 
+### Building and using from maven local
+
+1. Build the library
+   Run
+   ```shell
+   ./gradlew :source:publishToMavenLocal
+   ```
+   This will publish the library to your local maven repository.
+
+2. Update the version number in the news app
+   If the library version has changed, update it in the version catalog for the news app.
+
+3. Ensure you have `mavenLocal` declared first in your repositories
+   ```groovy
+   repositories {
+       mavenLocal()
+       mavenCentral()
+       google()
+   }
+   ```
+
 ### Other notes
 
 1. We use the `com.gu` package name and group id so we can use the Guardian's Sonatype infra for signing and publishing the library. See [this comment](https://github.com/guardian/source-android/pull/10/files?w=1#r1567071142) for reference. 

android/build.gradle.kts

@@ -13,6 +13,20 @@ plugins {
     alias(libs.plugins.kotlinter) apply false
     alias(libs.plugins.detekt) apply false
     alias(libs.plugins.paparazzi) apply false
+    alias(libs.plugins.nexus.publish)
+}
+
+
+group = libs.versions.group.get()
+version = libs.versions.libraryVersion.get()
+
+nexusPublishing {
+    repositories {
+        sonatype {
+            username = "guardian.automated.maven.release"
+            password = System.getenv("AUTOMATED_MAVEN_RELEASE_SONATYPE_PASSWORD")
+        }
+    }
 }
 
 allprojects {

android/gradle/libs.versions.toml

@@ -1,5 +1,6 @@
 [versions]
-libraryVersion = "0.1.0"
+group = "com.gu.source"
+libraryVersion = "0.1.1"
 compilesdk = "34"
 minsdk = "26"
 targetsdk = "33"
@@ -28,6 +29,7 @@ inject = "1"
 kotlinx-collections-immutable = "0.3.7"
 lifecycleRuntimeKtx = "2.7.0"
 lint-gradle = "1.0.0-alpha01"
+nexus-publish = "2.0.0"
 timber = "5.0.1"
 
 junit = "4.13.2"
@@ -92,6 +94,8 @@ kotlinter = { id = "org.jmailen.kotlinter", version.ref = "kotlinter" }
 detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }
 paparazzi = { id = "app.cash.paparazzi", version.ref = "paparazzi" }
 
+nexus-publish = { id = "io.github.gradle-nexus.publish-plugin", version.ref = "nexus-publish" }
+
 # Guardian's convention plugins
 guardian-application = { id = "com.theguardian.application", version.ref = "guardian-convention-plugins" }
 guardian-library-android = { id = "com.theguardian.library.android", version.ref = "guardian-convention-plugins" }

android/source/build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
 }
 
 android {
-    namespace = "com.gu.source"
+    namespace = libs.versions.group.get()
 
     defaultConfig {
         consumerProguardFiles("consumer-rules.pro")
@@ -39,13 +39,13 @@ dependencies {
 publishing {
     publications {
         register<MavenPublication>("release") {
-            groupId = "com.gu.source"
+            groupId = libs.versions.group.get()
             artifactId = "source-android"
             version = libs.versions.libraryVersion.get()
 
             pom {
                 name.set("Source Android")
-                description.set("Guardian design system library for Android")
+                description.set("The Guardian's design system library for Android")
                 url.set("https://github.com/guardian/source-apps")
                 packaging = "aar"
                 licenses {
@@ -81,16 +81,19 @@ publishing {
     }
 
     repositories {
-        maven {
-            name = "sonatype"
-            url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
-            credentials {
-                username = "guardian.automated.maven.release"
-                password = System.getenv("AUTOMATED_MAVEN_RELEASE_SONATYPE_PASSWORD")
-            }
-        }
+        // This is commented out because we're using nexus publishing plugin to publish to Sonatype.
+        // That's configured in the root build.gradle.kts file.
+//        maven {
+//            name = "sonatype"
+//            url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
+//            credentials {
+//                username = "guardian.automated.maven.release"
+//                password = System.getenv("AUTOMATED_MAVEN_RELEASE_SONATYPE_PASSWORD")
+//            }
+//        }
 
         // Adds a task for publishing locally to the build directory.
+        // Use as `./gradlew :source:publishReleasePublicationToGusourceRepository`
         maven {
             name = "gusource"
             url = uri("${project.buildDir}/gusource")