Skip to content

Latest commit

 

History

History
97 lines (79 loc) · 3.38 KB

README.md

File metadata and controls

97 lines (79 loc) · 3.38 KB
Raw

Azure BOM for client libraries

The Azure BOM for client libraries provides a verified group of Azure client libraries that are known to share common dependencies. It provides a simple and elegant way to orchestrate using multiple Azure client libraries while ensuring minimal dependency conflicts.

Table of contents

Getting started

Adding the BOM to your project

To consume the BOM include it in the dependencyManagement section of your project's POM. Note that this does not result in all dependencies being included in your project.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure</groupId>
      <artifactId>azure-sdk-bom</artifactId>
      <version>1.0.5</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

Adding libraries to your project

After adding the BOM, Azure client libraries included in the BOM are now available to be added as a dependency without listing the artifact's version.

<dependencies>
  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-storage-blob</artifactId>
  </dependency>
  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-security-keyvault-secrets</artifactId>
  </dependency>
  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
  </dependency>
</dependencies>

Adding library dependencies to your project

In addition to containing Azure client libraries the BOM also list dependencies that the Azure client libraries use. These are added to allow the BOM to configure them to reduce dependency conflict on commonly used libraries such as Jackson, Netty, OkHttp, SLF4J, and more.

<dependencies>
  <dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
  </dependency>
  <dependency>
    <groupId>io.projectreactor.netty</groupId>
    <artifactId>reactor-netty</artifactId>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
  </dependency>
</dependencies>

Overview

Release cadence

Currently, the azure-sdk-bom releases on a quarterly cycle, excluding the end of year quarter (November - January). Releases will occur in February, May, and August using the latest GA versions of managed libraries which meet the requirement for release.

Requirements for release

The azure-sdk-bom has additional release requirements not found in other Azure SDKs. For the azure-sdk-bom to be considered as a release candidate all managed Azure SDK libraries contained within in it must have strong alignment on the Core SDK libraries. For example, all libraries must be using the same version of azure-core to be a viable release candidate.

Included library requirements

Only GA'd Azure SDKs in the com.azure group are permitted to be managed dependencies in the azure-sdk-bom. SDKs that have yet to be GA'd won't be considered at this time as the azure-sdk-bom is meant to act as a production ready dependency management system for applications built using Azure SDKs.