Merge pull request #3 from inwx/maven_publishing

Makes project ready for maven central

Author: ddmler

README.md

@@ -18,31 +18,23 @@ If you still experience any kind of problems don't hesitate to contact our [supp
 
 Installation
 -------
-Currently you have to publish the gradle project to your local repository.
-
-#### Build the project and publish it to your local maven repository:
-```bash
-./gradlew publishToMavenLocal
-```
 
 #### Add the domrobot as a dependency:
 
 If you use gradle:
 ```gradle
-compile 'com.inwx.domrobot:java-client:3.0'
+compile 'com.inwx:domrobot:3.1'
 ```
 
 Or if you use maven:
 ```xml
 <dependency>
-    <groupId>com.inwx.domrobot</groupId>
-    <artifactId>java-client</artifactId>
-    <version>3.0</version>
+    <groupId>com.inwx</groupId>
+    <artifactId>domrobot</artifactId>
+    <version>3.1</version>
 </dependency>
 ```
 
-We are working on getting it into the official maven repository.
-
 Example
 -------
 
@@ -58,7 +50,7 @@ public class DomaincheckExample {
 
         String username = "";
         String password = "";
-        String sharedSecret = "";
+        String sharedSecret = ""; // Only necessary if 2FA is enabled.
         String domain = "my-test-domain-which-is-definitely-not-registered6737.com";
 
         // By default the ApiClient uses the test api (OT&E). If you want to use the production/live api

build.gradle

@@ -4,8 +4,8 @@ plugins {
     id 'maven-publish'
 }
 
-group 'com.inwx.domrobot'
-version '3.0'
+group 'com.inwx'
+version '3.1'
 
 allprojects {
     if (project.plugins.hasPlugin('java')) {
@@ -23,10 +23,4 @@ dependencies {
     implementation 'org.apache.httpcomponents:httpclient:4.5.9'
 }
 
-publishing {
-    publications {
-        maven(MavenPublication) {
-            from components.java
-        }
-    }
-}
+apply from: './deploy.gradle'

deploy.gradle

@@ -0,0 +1,85 @@
+apply plugin: 'maven-publish'
+apply plugin: 'signing'
+
+gradle.taskGraph.whenReady { taskGraph ->
+    if (taskGraph.allTasks.any { it instanceof Sign } && project.ext.isReleaseVersion) {
+        def id = System.getenv('GPG_ID') ?: $GPG_ID
+        def file = System.getenv('GPG_SECRET_KEY_RING_FILE') ?: $GPG_SECRET_KEY_RING_FILE
+        def password = System.getenv('GPG_PASSWORD') ?: $GPG_PASSWORD
+
+        allprojects { ext."signing.keyId" = id }
+        allprojects { ext."signing.secretKeyRingFile" = file }
+        allprojects { ext."signing.password" = password }
+    }
+}
+
+ext {
+    isReleaseVersion = !(project.version =~ /-SNAPSHOT$/)
+    isNeedSign = System.getenv('GPG_ID') && isReleaseVersion
+}
+
+task sourcesJar(type: Jar) {
+    from sourceSets.main.allJava
+    archiveClassifier.set('sources')
+}
+
+task javadocJar(type: Jar) {
+    from javadoc
+    archiveClassifier.set('javadoc')
+}
+
+publishing {
+    publications {
+        mavenJava(MavenPublication) {
+
+            from components.java
+            artifact sourcesJar
+            artifact javadocJar
+
+            pom {
+                name = 'INWX Domrobot Java Client'
+                description = 'INWX Domrobot Java Client'
+                url = 'https://github.com/inwx/java-client'
+                licenses {
+                    license {
+                        name = 'MIT License'
+                        url = 'http://www.opensource.org/licenses/mit-license.php'
+                        distribution = 'repo'
+                    }
+                }
+                developers {
+                    developer {
+                        id = 'developer-inwx'
+                        name = 'INWX Developer'
+                        email = '[email protected]'
+                        organization = 'INWX GmbH & Co. KG'
+                        organizationUrl = 'https://www.inwx.com/en/'
+                    }
+                }
+                scm {
+                    connection = 'scm:git:git://github.com/inwx/java-client.git'
+                    developerConnection = 'scm:git:[email protected]:inwx/java-client.git'
+                    url = 'https://github.com/inwx/java-client'
+                }
+            }
+        }
+    }
+    repositories {
+        maven {
+            credentials {
+                username System.getenv('OSSRH_USER') ?: $OSSRH_USER
+                password System.getenv('OSSRH_PASS') ?: $OSSRH_PASS
+            }
+            if (project.ext.isReleaseVersion) {
+                url "https://oss.sonatype.org/service/local/staging/deploy/maven2"
+            } else {
+                url "https://oss.sonatype.org/content/repositories/snapshots"
+            }
+        }
+    }
+
+    signing {
+        required { project.ext.isNeedSign }
+        sign publishing.publications.mavenJava
+    }
+}

examples/src/main/java/com/inwx/domrobot/DomaincheckExample.java

@@ -9,7 +9,7 @@ public static void main(String[] args) throws Exception {
 
         String username = "";
         String password = "";
-        String sharedSecret = "";
+        String sharedSecret = ""; // Only necessary if 2FA is enabled.
         String domain = "my-test-domain-which-is-definitely-not-registered6737.com";
 
         // By default the ApiClient uses the test api (OT&E). If you want to use the production/live api

examples/src/main/java/com/inwx/domrobot/DomaincheckWithCustomModelsExample.java

@@ -12,7 +12,7 @@ public static void main(String[] args) throws Exception {
 
         String username = "";
         String password = "";
-        String sharedSecret = "";
+        String sharedSecret = ""; // Only necessary if 2FA is enabled.
         String domain = "my-test-domain-which-is-definitely-not-registered6737.com";
 
         ApiClient client = new ApiClient(ApiClient.OTE_URL, true);

gradle.properties

@@ -0,0 +1,9 @@
+# Signing settings
+$GPG_ID=
+## Must be absolute path
+$GPG_SECRET_KEY_RING_FILE=
+$GPG_PASSWORD=
+
+# Publish settings
+$OSSRH_USER=
+$OSSRH_PASS=

settings.gradle

@@ -1,3 +1,3 @@
-rootProject.name = 'java-client'
+rootProject.name = 'domrobot'
 include 'examples'