Prelim SDK BOM for this month. (#26587)

BOM release for this month with additional changes to the generator to strip out external dependencies.
Azure · Jan 26, 2022 · 5c24c9a · 5c24c9a
1 parent 30f53ee
commit 5c24c9a
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 164 deletions.
diff --git a/eng/bomgenerator/generateAzureSDKBOM.ps1 b/eng/bomgenerator/generateAzureSDKBOM.ps1
@@ -20,5 +20,5 @@ if(! (Test-Path $defaultPomFilePath)) {
  Copy-Item $bomPomFilePath -Destination $inputDir
 }
 
-$mvnResults = mvn install
-$mvnResults = "mvn exec:java -Dexec.args=`"-inputDir=$inputDir -outputDir=$outputDir -mode=generate`""
+echo "Run the following to generate the Pom file and dependency closure report. Both files will be generated in the outputDir."
+echo "mvn exec:java -Dexec.args=`"-inputDir=$inputDir -outputDir=$outputDir -mode=generate`""
diff --git a/eng/bomgenerator/report.log b/eng/bomgenerator/report.log
diff --git a/eng/bomgenerator/src/main/java/com/azure/tools/bomgenerator/BomGenerator.java b/eng/bomgenerator/src/main/java/com/azure/tools/bomgenerator/BomGenerator.java
@@ -336,6 +336,9 @@ private void writeBom(Collection<BomDependency> bomDependencies) {
         }).collect(Collectors.toList());
         dependencies.addAll(externalBomDependencies);
         dependencies.sort(new DependencyComparator());
+
+        // Remove external dependencies from the BOM.
+        dependencies = dependencies.stream().filter(dependency -> BASE_AZURE_GROUPID.equals(dependency.getGroupId())).collect(Collectors.toList());
         management.setDependencies(dependencies);
         writeModel(this.pomFileName, this.outputFileName, model);
     }

diff --git a/sdk/boms/azure-sdk-bom/CHANGELOG.md b/sdk/boms/azure-sdk-bom/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Release History
 
+## 1.1.0 (2021-01-22)
+
+### Dependency Updates
+
+- Updated Azure SDK dependency versions to more recent releases.
+- Removed non-Azure SDK dependencies from the Azure SDK BOM.
+Azure SDK BOM used to include external dependencies till now however this let to [dependency conflicts](https://github.com/Azure/azure-sdk-for-java/issues/26217)
+in situations where our libraries were used along side other frameworks. Given the above we are removing 3rd party dependencies from the BOM and letting the Azure SDK Client implementation libraries bring them in at runtime. 
+We continue to ensure all our client libraries have unified set of external dependencies to prevents conflicts when used together.
+
+#### Breaking Changes
+If you depend on Azure SDK BOM to get versions for external libraries you would now see compilation errors in your project. Please explicitly add the required versions of your external dependencies to your project POM files. 
+Depending on implicit version for transitive dependencies should be avoided as it is not a recommended practice. 
+
 ## 1.0.6 (2021-11-22)
 
 ### Dependency Updates