Describe how to resolve conflicting plugin depenecies (#463)

allegro · May 23, 2022 · 2117759 · 2117759
1 parent 81f10c4
commit 2117759
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/configuration/resolving_dependency_conflicts.md b/docs/configuration/resolving_dependency_conflicts.md
@@ -0,0 +1,15 @@
+# Resolving dependency conflicts
+
+`axion-release-plugin` uses [JGit](https://www.eclipse.org/jgit/) and [JSch](http://www.jcraft.com/jsch/)
+ under the hood. Other Gradle plugins can have version conflicts with those dependencies.
+
+In order to resolve such conflicts specify dependency explicitly. Eg. for JGit:
+
+    buildscript {
+        dependencies {
+            classpath("pl.allegro.tech.build:axion-release-plugin:<version>") {
+                exclude group: "org.eclipse.jgit"
+            }
+            classpath("org.eclipse.jgit:org.eclipse.jgit:5.12.0.202106070339-r")
+        }
+    }
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -38,4 +38,5 @@ nav:
     - Publishing: 'configuration/publishing.md'
     - Dry run: 'configuration/dry_run.md'
     - CI Servers: 'configuration/ci_servers.md'
+    - Resolving dependency conflicts: 'configuration/resolving_dependency_conflicts.md'
     - Extensions: 'configuration/extensions.md'