Document temporary workaround when importing transitively

Importing each dependency non-transitively (as suggested in #253) might require users to specify each dependency indivifually, which might quickly feel cumbersome. ref #253 ref #294
rm3l · Apr 22, 2022 · 547ced7 · 547ced7
1 parent 3653a96
commit 547ced7
Show file tree

Hide file tree

Showing 6 changed files with 100 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -140,7 +140,11 @@ Declare the [Maven Central repository](https://repo.maven.apache.org/maven2/) (i
 
   dependencies {
     // ...
-    implementation 'org.rm3l:maoni:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 
@@ -203,7 +207,11 @@ Add this additional line to your `build.gradle`:
 ```gradle
   dependencies {
     // ...
-    implementation 'org.rm3l:maoni:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 
@@ -233,8 +241,16 @@ Add this additional line to your `build.gradle`:
 ```gradle
   dependencies {
     // ...
-    implementation 'org.rm3l:maoni:10.0.0@aar'
-    implementation 'org.rm3l:maoni-slack:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
+    implementation('org.rm3l:maoni-slack:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 
@@ -263,8 +279,16 @@ Add this additional line to your `build.gradle`:
 
 ```gradle
   dependencies {
-    implementation 'org.rm3l:maoni:10.0.0@aar'
-    implementation 'org.rm3l:maoni-github:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
+    implementation('org.rm3l:maoni-github:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 
@@ -294,8 +318,16 @@ Add this additional line to your `build.gradle`:
 
 ```gradle
   dependencies {
-    implementation 'org.rm3l:maoni:10.0.0@aar'
-    implementation 'org.rm3l:maoni-jira:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
+    implementation('org.rm3l:maoni-jira:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 
@@ -326,8 +358,16 @@ Add this additional line to your `build.gradle`:
 ```gradle
   dependencies {
     // ...
-    implementation 'org.rm3l:maoni:10.0.0@aar'
-    implementation 'org.rm3l:maoni-doorbell:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
+    implementation('org.rm3l:maoni-doorbell:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 
@@ -460,7 +500,11 @@ You just have to include `maoni-common` as a dependency in your project, e.g., w
 ```gradle
   dependencies {
     // ...
-    api 'org.rm3l:maoni-common:10.0.0@aar'
+    api('org.rm3l:maoni-common:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 You can write your project in any JVM language of your choice (e.g., [Kotlin](https://kotlinlang.org/), as with [maoni-slack](https://github.com/rm3l/maoni-slack) and [maoni-github](https://github.com/rm3l/maoni-github)), as long as the callback implementation can be called from Maoni.

diff --git a/callbacks/maoni-doorbell/README.md b/callbacks/maoni-doorbell/README.md
@@ -17,8 +17,16 @@ Add this to your `build.gradle`:
 
 ```gradle
   dependencies {
-    implementation 'org.rm3l:maoni:10.0.0@aar'
-    implementation 'org.rm3l:maoni-doorbell:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
+    implementation('org.rm3l:maoni-doorbell:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 

diff --git a/callbacks/maoni-email/README.md b/callbacks/maoni-email/README.md
@@ -16,8 +16,11 @@ Add this to your `build.gradle`:
 
 ```gradle
   dependencies {
-    implementation 'org.rm3l:maoni:10.0.0@aar'
-    implementation 'org.rm3l:maoni-email:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 

diff --git a/callbacks/maoni-github/README.md b/callbacks/maoni-github/README.md
@@ -19,8 +19,16 @@ Add this to your `build.gradle`:
 
 ```gradle
   dependencies {
-    implementation 'org.rm3l:maoni:10.0.0@aar'
-    implementation 'org.rm3l:maoni-github:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
+    implementation('org.rm3l:maoni-github:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 

diff --git a/callbacks/maoni-jira/README.md b/callbacks/maoni-jira/README.md
@@ -17,8 +17,16 @@ Add this to your `build.gradle`:
 
 ```gradle
   dependencies {
-    implementation 'org.rm3l:maoni:10.0.0@aar'
-    implementation 'org.rm3l:maoni-jira:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
+    implementation('org.rm3l:maoni-jira:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```
 

diff --git a/callbacks/maoni-slack/README.md b/callbacks/maoni-slack/README.md
@@ -21,8 +21,16 @@ Now in your app, add this to your `build.gradle`:
 
 ```gradle
   dependencies {
-    implementation 'org.rm3l:maoni:10.0.0@aar'
-    implementation 'org.rm3l:maoni-slack:10.0.0@aar'
+    implementation('org.rm3l:maoni:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
+    implementation('org.rm3l:maoni-slack:10.0.0@aar') {
+        transitive = true
+        //Needed because of https://github.com/rm3l/maoni/issues/294
+        exclude module: 'unspecified'
+    }
   }
 ```