From 560c95a88d3e5e7b7ec815adf39c0a2e07be4a6e Mon Sep 17 00:00:00 2001
From: Scott Leberknight <174812+sleberknight@users.noreply.github.com>
Date: Sun, 10 Apr 2022 16:35:28 -0400
Subject: [PATCH] Add comments to BOM explaining several "odd" dependencies
 (#142)

* Add comments explaining why a few dependencies were added to
  resolve dependency convergence errors

Closes #135
---
 pom.xml | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/pom.xml b/pom.xml
index 1c81d445..38174ebd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -379,6 +379,11 @@
                 <version>${jackson.version}</version>
             </dependency>
 
+            <!--
+                This is here to resolve dependency conflicts between the version used by
+                com.sun.xml.ws:jaxws-rt and com.sun.mail:jakarta.mail. It should be
+                re-evaluated from time-to-time.
+            -->
             <dependency>
                 <groupId>com.sun.activation</groupId>
                 <artifactId>jakarta.activation</artifactId>
@@ -487,6 +492,10 @@
                 <version>${jersey.version}</version>
             </dependency>
 
+            <!--
+                This is here due to dropwizard (testing, client, etc.) being stuck on Jersey 2.33. At Dropwizard 2.1.0
+                they've moved to Jersey 2.35, so we can probably remove at that point.
+            -->
             <dependency>
                 <groupId>org.glassfish.jersey.containers</groupId>
                 <artifactId>jersey-container-servlet-core</artifactId>
@@ -649,6 +658,10 @@
                 <version>${netty.version}</version>
             </dependency>
 
+            <!--
+                This was added to resolve conflicts with mongo-java-server.
+                It should be re-evaluated from time-to-time.
+            -->
             <dependency>
                 <groupId>io.netty</groupId>
                 <artifactId>netty-codec</artifactId>