Migrate from Bintray/JCenter to Maven Central for publishing (#24)

Rolf-Smit · web-flow · commit 03243f3b5155 · 2021-03-19T00:39:50.000+01:00
- Updated documentation
- Removed obsolete documentation
diff --git a/README.md b/README.md
@@ -15,18 +15,38 @@ up as "covered" when tests in Module A touch it.
   - Supports different build variants per module within the same report.
   - Supports custom package/class filters.
 
+> Notice: Due to the [shutdown of Bintray/JCenter](https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/)
+> the Android-Root-Coverage-Plugin has been migrated
+> to Sonatype's Maven Central repository. Unfortunately this also meant that the group ID used by
+> the Android-Root-Coverage-Plugin had to be changed from `org.neotech.plugin` to
+> `nl.neotech.plugin`. The plugin ID has also changed from `org.neotech.plugin.rootcoverage` to
+> `nl.neotech.plugin.rootcoverage`.
+>
+> Soon current release (1.3.0) and older versions will no longer be available through
+> Bintray/JCenter, however since these versions have also been released to the Gradle Plugin Portal,
+> you can use that repository instead:
+> ```groovy
+> maven {
+>     url "https://plugins.gradle.org/m2/"
+> }
+> ```
+>
+> The current version has been re-released with the new group ID and plugin ID to Maven Central and
+> the Gradle Plugin Portal (1.3.1), new versions will also be released to these repositories. See
+> the 'Setup' section of this readme on how to use this plugin with the updated group ID and
+> plugin ID.
 
 # Setup
 Apply the Android-Root-Coverage-Plugin plugin to your top-level (root project) gradle file:
 
 ```groovy
 // Step 2: Apply the plugin to the top-level gradle file
-apply plugin: 'org.neotech.plugin.rootcoverage'
+apply plugin: 'nl.neotech.plugin.rootcoverage'
 
 buildscript {
     dependencies {
         // Step 1: add the dependency
-        classpath 'org.neotech.plugin:android-root-coverage-plugin:1.3.0'
+        classpath 'nl.neotech.plugin:android-root-coverage-plugin:1.3.1'
     }
 }
 ```
@@ -60,13 +80,16 @@ Android Studio using the Gradle Tool Window (see:
 # Compatibility
 | Version       | Android Gradle plugin version | Gradle version |
 | ------------- | ----------------------------- | -------------- |
-| **1.3.0**     | 3.6                           | 5.6.4+         |
+| **1.3.1**     | 3.6                           | 5.6.4+         |
 | **1.2.1**     | 3.5                           | 5.4.1+         |
 | **1.1.2**     | 3.4                           | 5.1.1+         |
 | **1.1.1**     | 3.3                           | 4.10.1+        |
-| ~~**1.1.0**~~ | ~~3.3~~                       | ~~5+~~         |
 | **1.0.2**     | 3.2                           | 4.6+           |
 
+*Note: Versions below 1.3.1, such as 1.3.0, are only available on the Gradle Plugin Portal
+(`maven { url "https://plugins.gradle.org/m2/"}`) and not on Maven Central. These versions use the
+group ID `org.neotech.plugin` and plugin ID `org.neotech.plugin.rootcoverage`!*
+
 *Note: This plugin normally supports exactly the same Gradle versions as the Android Gradle
 plugin, for more information please refer to:* 
 <https://developer.android.com/studio/releases/gradle-plugin#updating-gradle>
@@ -93,6 +116,11 @@ rootCoverage {
     // Class exclude patterns
     excludes = ["**/some.package/**"]
 
+    // Since 1.1 generateHtml is by default true
+    generateCsv false
+    generateHtml true
+    generateXml false
+
     // Since 1.2: When false the plugin does not execute any tests, useful when you run the tests manually or remote (Firebase Test Lab)
     executeTests true
     
@@ -121,10 +149,7 @@ projects. But if you like to add some actually functionality, this is the wish l
 
 **How to test your changes/additions?**
 The plugin comes with an integration test. You can run this test either by executing
-`gradlew clean test` or run the test directly from Android Studio (or IntelliJ IDEA) using a proper run/test
-configuration as shown in the image *(by default it generates configuration that is not compatible
-with a plugin module)*:
-![Correct run/test configuration](correct-test-run-configuration.png)
+`gradlew clean test` or run the test directly from Android Studio (or IntelliJ IDEA).
 
 
 # Author note
diff --git a/build.gradle b/build.gradle
@@ -7,19 +7,26 @@ buildscript {
     apply from: "gradle/dependencies.gradle"
 
     repositories {
+        gradlePluginPortal()
         google()
-        jcenter()
+        mavenCentral()
     }
 
     dependencies {
-        classpath "com.github.ben-manes:gradle-versions-plugin:0.28.0"
+        classpath "com.github.ben-manes:gradle-versions-plugin:0.38.0"
     }
 }
 
 allprojects {
     repositories {
         google()
-        jcenter()
+        mavenCentral()
+        jcenter {
+            content {
+                // https://youtrack.jetbrains.com/issue/IDEA-261387
+                includeModule("org.jetbrains.trove4j", "trove4j")
+            }
+        }
     }
 }
 
diff --git a/correct-test-run-configuration.png b/correct-test-run-configuration.png
diff --git a/gradle.properties b/gradle.properties
@@ -13,25 +13,17 @@ org.gradle.jvmargs=-Xmx1536m
 # org.gradle.parallel=true
 
 
-#These properties should be added to module specific gradle.properties files
-#NAME=
-#ARTIFACT_ID=
-#PACKAGING=jar
+GROUP=nl.neotech.plugin
 
-GROUP=org.neotech.plugin
-VERSION=1.3.0
-DESCRIPTION=A Gradle plugin for easy generation of combined code coverage reports for Android projects with multiple modules.
+POM_URL=https://github.com/NeoTech-Software/android-root-coverage-plugin
+POM_SCM_URL=https://github.com/NeoTech-Software/android-root-coverage-plugin
+POM_SCM_CONNECTION=scm:git:git://github.com/NeoTech-Software/android-root-coverage-plugin.git
+POM_SCM_DEV_CONNECTION=scm:git:git://github.com/NeoTech-Software/android-root-coverage-plugin.git
 
-PROJECT_WEBSITE=https://github.com/NeoTech-Software/android-root-coverage-plugin
-SCM_URL=https://github.com/NeoTech-Software/android-root-coverage-plugin
-SCM_CONNECTION=scm:git:git://github.com/NeoTech-Software/android-root-coverage-plugin.git
-SCM_DEV_CONNECTION=scm:git:git://github.com/NeoTech-Software/android-root-coverage-plugin.git
+POM_LICENCE_NAME=The Apache Software License, Version 2.0
+POM_LICENCE_URL=https://www.apache.org/licenses/LICENSE-2.0.txt
+POM_LICENCE_DIST=repo
 
-LICENCE=Apache-2.0
-LICENCE_NAME=The Apache Software License, Version 2.0
-LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt
-LICENCE_DIST=repo
-
-DEVELOPER_ID=rolf-smit
-DEVELOPER_NAME=Rolf Smit
-DEVELOPER_EMAIL=contact@neotechsoftware.com
+POM_DEVELOPER_ID=rolf-smit
+POM_DEVELOPER_NAME=Rolf Smit
+POM_DEVELOPER_URL=https://github.com/username/
diff --git a/gradle/dependencies.gradle b/gradle/dependencies.gradle
@@ -29,8 +29,9 @@ ext {
     pluginVersions = [
             "org.jetbrains.kotlin.android"      : "${projectVersion.kotlin}",
             "org.jetbrains.kotlin.jvm"          : "${projectVersion.kotlin}",
-            "com.jfrog.bintray"                 : "1.8.4",
             "com.github.dcendents.android-maven": "2.1",
-            "com.gradle.plugin-publish"         : "0.10.1"
+            "com.gradle.plugin-publish"         : "0.10.1",
+            "org.jetbrains.dokka"               : "1.4.30",
+            "com.vanniktech.maven.publish"      : "0.13.0"
     ]
 }
diff --git a/plugin/build.gradle b/plugin/build.gradle
@@ -2,34 +2,63 @@ plugins {
     id "org.jetbrains.kotlin.jvm"
     id "java-gradle-plugin"
 
-    // For publishing to Plugin Portal & Bintray
+    // For publishing to Plugin Portal & Maven Central
     id "com.gradle.plugin-publish"
     id "com.github.dcendents.android-maven"
-    id "com.jfrog.bintray"
+    id "org.jetbrains.dokka"
+    id "com.vanniktech.maven.publish" apply false
 }
 
-// To upload new plugin artifact to maven and Gradle Portal:
-// > gradlew bintrayUpload publishPlugins
+// See: https://github.com/vanniktech/gradle-maven-publish-plugin/issues/206
+ext {
+    RELEASE_REPOSITORY_URL = "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/"
+    SNAPSHOT_REPOSITORY_URL = "https://s01.oss.sonatype.org/content/repositories/snapshots/"
+}
+
+apply plugin: "com.vanniktech.maven.publish"
+
+// To upload new plugin artifact Gradle Portal:
+// > ./gradlew publishPlugins
+//
+// To upload new plugin artifact to Maven Central Repository:
+// > ./gradlew publishPluginMavenPublicationToMavenCentralRepository --no-daemon --no-parallel
 //
 // To test the plugin:
-// > gradlew clean test
+// > ./gradlew clean test
 
 sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8
 
+
+publishing {
+    repositories {
+        maven {
+            url = version.endsWith('SNAPSHOT') ? SNAPSHOT_REPOSITORY_URL : RELEASE_REPOSITORY_URL
+            name = "mavenCentral"
+            credentials {
+                Properties properties = new Properties()
+                properties.load(project.rootProject.file('local.properties').newDataInputStream())
+
+                username = properties.getProperty("ossrhUsername")
+                password = properties.getProperty("ossrhPassword")
+            }
+        }
+    }
+}
+
 gradlePlugin {
     plugins {
         rootCoverage {
-            id = 'org.neotech.plugin.rootcoverage'
+            id = 'nl.neotech.plugin.rootcoverage'
             implementationClass = 'org.neotech.plugin.rootcoverage.RootCoveragePlugin'
         }
     }
 }
 
 pluginBundle {
-    setWebsite(PROJECT_WEBSITE)
-    vcsUrl = 'https://github.com/NeoTech-Software/Android-Root-Coverage-Plugin'
-    setDescription(DESCRIPTION)
+    setWebsite(POM_URL)
+    vcsUrl = POM_SCM_URL
+    setDescription(POM_DESCRIPTION)
     tags = ['android', 'coverage', 'jacoco', 'code-coverage', 'coverage-report', 'aggregated-report']
 
     plugins {
@@ -40,8 +69,8 @@ pluginBundle {
 
     mavenCoordinates {
         groupId = GROUP
-        artifactId = ARTIFACT_ID
-        version = VERSION
+        artifactId = POM_ARTIFACT_ID
+        version = VERSION_NAME
     }
 }
 
@@ -66,4 +95,4 @@ dependencies {
     testImplementation projectDependency.commonsCsv
 }
 
-apply from: rootProject.file('publish.gradle')
+// apply from: rootProject.file('publish.gradle')
diff --git a/plugin/gradle.properties b/plugin/gradle.properties
@@ -1,3 +1,4 @@
-ARTIFACT_ID=android-root-coverage-plugin
-NAME=Android-Root-Coverage-Plugin
-PACKAGING=jar
+POM_ARTIFACT_ID=android-root-coverage-plugin
+VERSION_NAME=1.3.1
+POM_NAME=Android Root Coverage Plugin
+POM_DESCRIPTION=A Gradle plugin for easy generation of combined code coverage reports for Android projects with multiple modules.
diff --git a/plugin/src/test/test-fixtures/multi-module/build.gradle b/plugin/src/test/test-fixtures/multi-module/build.gradle
@@ -7,7 +7,7 @@ buildscript {
 
     repositories {
         google()
-        jcenter()
+        mavenCentral()
     }
     dependencies {
         classpath projectDependency.androidGradlePlugin
@@ -18,13 +18,13 @@ buildscript {
 
 plugins {
     id 'jacoco'
-    id 'org.neotech.plugin.rootcoverage'
+    id 'nl.neotech.plugin.rootcoverage'
 }
 
 allprojects {
     repositories {
         google()
-        jcenter()
+        mavenCentral()
     }
 }
 
@@ -34,7 +34,7 @@ task clean(type: Delete) {
 
 jacoco {
     // https://www.jacoco.org/jacoco/trunk/doc/changes.html
-    toolVersion = "0.8.5"
+    toolVersion = "0.8.6"
 }
 
 rootCoverage {
diff --git a/publish.gradle b/publish.gradle

Original file line number	Diff line number	Diff line change
`@@ -7,19 +7,26 @@ buildscript {`
`7`	`7`	`apply from: "gradle/dependencies.gradle"`
`8`	`8`
`9`	`9`	`repositories {`
	`10`	`+ gradlePluginPortal()`
`10`	`11`	`google()`
`11`		`- jcenter()`
	`12`	`+ mavenCentral()`
`12`	`13`	`}`
`13`	`14`
`14`	`15`	`dependencies {`
`15`		`- classpath "com.github.ben-manes:gradle-versions-plugin:0.28.0"`
	`16`	`+ classpath "com.github.ben-manes:gradle-versions-plugin:0.38.0"`
`16`	`17`	`}`
`17`	`18`	`}`
`18`	`19`
`19`	`20`	`allprojects {`
`20`	`21`	`repositories {`
`21`	`22`	`google()`
`22`		`- jcenter()`
	`23`	`+ mavenCentral()`
	`24`	`+ jcenter {`
	`25`	`+ content {`
	`26`	`+ // https://youtrack.jetbrains.com/issue/IDEA-261387`
	`27`	`+ includeModule("org.jetbrains.trove4j", "trove4j")`
	`28`	`+ }`
	`29`	`+ }`
`23`	`30`	`}`
`24`	`31`	`}`
`25`	`32`
Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,9 @@ ext {`
`29`	`29`	`pluginVersions = [`
`30`	`30`	`"org.jetbrains.kotlin.android" : "${projectVersion.kotlin}",`
`31`	`31`	`"org.jetbrains.kotlin.jvm" : "${projectVersion.kotlin}",`
`32`		`- "com.jfrog.bintray" : "1.8.4",`
`33`	`32`	`"com.github.dcendents.android-maven": "2.1",`
`34`		`- "com.gradle.plugin-publish" : "0.10.1"`
	`33`	`+ "com.gradle.plugin-publish" : "0.10.1",`
	`34`	`+ "org.jetbrains.dokka" : "1.4.30",`
	`35`	`+ "com.vanniktech.maven.publish" : "0.13.0"`
`35`	`36`	`]`
`36`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ buildscript {`
`7`	`7`
`8`	`8`	`repositories {`
`9`	`9`	`google()`
`10`		`- jcenter()`
	`10`	`+ mavenCentral()`
`11`	`11`	`}`
`12`	`12`	`dependencies {`
`13`	`13`	`classpath projectDependency.androidGradlePlugin`
`@@ -18,13 +18,13 @@ buildscript {`
`18`	`18`
`19`	`19`	`plugins {`
`20`	`20`	`id 'jacoco'`
`21`		`- id 'org.neotech.plugin.rootcoverage'`
	`21`	`+ id 'nl.neotech.plugin.rootcoverage'`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`allprojects {`
`25`	`25`	`repositories {`
`26`	`26`	`google()`
`27`		`- jcenter()`
	`27`	`+ mavenCentral()`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`
`@@ -34,7 +34,7 @@ task clean(type: Delete) {`
`34`	`34`
`35`	`35`	`jacoco {`
`36`	`36`	`// https://www.jacoco.org/jacoco/trunk/doc/changes.html`
`37`		`- toolVersion = "0.8.5"`
	`37`	`+ toolVersion = "0.8.6"`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`rootCoverage {`