Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Azure SDK BOM #7807

Merged
merged 8 commits into from
Feb 4, 2020
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
# Catch all
/sdk/ @joshfree @jonathangiles

# BOM
/sdk/bom/ @alzimmermsft @jonathangiles

# Service teams
/sdk/appconfiguration/ @mssfang @alzimmermsft @conniey @sima-zhu
/sdk/batch/ @xingwu1 @bgklein @matthchr
Expand Down
48 changes: 48 additions & 0 deletions sdk/bom/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Azure BOM for client libraries
The Azure BOM for client libraries provides a verified group of artifacts that are known to share a common dependency set. It provides a simple and elegant way to manage dependencies on multiple Azure client libraries.

## Table of contents
- [Getting started](#getting-started)
- [Adding the BOM to your project](#adding-the-bom-to-your-project)
- [Adding libraries to your project](#adding-libraries-to-your-project)

## Getting started

### Adding the BOM to your project

To consume the BOM add it as an artifact in the dependency management section of your project's POM.

```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-sdk-bom</artifactId>
<version>1.0.0-beta.1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
```

### Adding libraries to your project

After adding the BOM all artifacts included in the BOM are now available to be added as a dependency without listing the artifact's version.

```xml
<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>
```
131 changes: 131 additions & 0 deletions sdk/bom/azure-sdk-bom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<modelVersion>4.0.0</modelVersion>
<groupId>com.azure</groupId>
<artifactId>azure-sdk-bom</artifactId>
<version>1.0.0-beta.1</version>
<packaging>pom</packaging>
<name>Azure Java SDK BOM (Bill of Materials)</name>
<description>Azure Java SDK BOM (Bill of Materials)</description>
<url>https://github.com/azure/azure-sdk-for-java</url>

<licenses>
<license>
<name>The MIT License (MIT)</name>
<url>http://opensource.org/licenses/MIT</url>
<distribution>repo</distribution>
</license>
</licenses>

<developers>
<developer>
<id>microsoft</id>
<name>Microsoft Corporation</name>
</developer>
</developers>

<scm>
<connection>scm:git:git://github.com/azure/azure-sdk-for-java</connection>
<developerConnection>scm:git:git://github.com/azure/azure-sdk-for-java</developerConnection>
<url>https://github.com/azure/azure-sdk-for-java</url>
</scm>

<issueManagement>
<system>GitHub</system>
<url>https://github.com/azure/azure-sdk-for-java/issues</url>
</issueManagement>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core</artifactId>
<version>1.2.0</version>
</dependency>

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core-http-netty</artifactId>
<version>1.2.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core-http-okhttp</artifactId>
<version>1.1.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-data-appconfiguration</artifactId>
<version>1.0.1</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.0.2</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-security-keyvault-certificates</artifactId>
<version>4.0.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-security-keyvault-keys</artifactId>
<version>4.1.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-security-keyvault-secrets</artifactId>
<version>4.1.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob</artifactId>
<version>12.2.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob-batch</artifactId>
<version>12.2.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-blob-cryptography</artifactId>
<version>12.2.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-common</artifactId>
<version>12.2.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-file-share</artifactId>
<version>12.1.0</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-storage-queue</artifactId>
<version>12.2.0</version>
</dependency>
</dependencies>
</dependencyManagement>

<build>
<plugins>
<plugin>
<groupId>net.jonathangiles.tools</groupId>
<artifactId>dependencyChecker-maven-plugin</artifactId>
<version>1.0.2</version>
<configuration>
<reporters>html</reporters>
<showAll>true</showAll>
<analyseBom>true</analyseBom>
<failOnDependencyConflict>true</failOnDependencyConflict>
</configuration>
</plugin>
</plugins>
</build>
</project>
43 changes: 43 additions & 0 deletions sdk/bom/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# DO NOT EDIT THIS FILE
# This file is generated automatically and any changes will be lost.

resources:
repositories:
- repository: azure-sdk-build-tools
type: git
name: internal/azure-sdk-build-tools
- repository: azure-sdk-tools
type: github
name: Azure/azure-sdk-tools
endpoint: azure

trigger:
branches:
include:
- master
- hotfix/*
- release/*
paths:
include:
- sdk/bom/

pr:
branches:
include:
- master
- feature/*
- hotfix/*
- release/*
paths:
include:
- sdk/bom/

stages:
- template: ../../eng/pipelines/templates/stages/archetype-sdk-client.yml
parameters:
ServiceDirectory: bom
Artifacts:
- name: azure-sdk-bom
groupId: com.azure
safeName: azuresdkbom
stagingProfileId: 88192f04117501
6 changes: 6 additions & 0 deletions sdk/bom/dependencies.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[
{
"projectName": "azure-sdk-for-java",
"bom": "./azure-sdk-bom.xml"
}
]
6 changes: 6 additions & 0 deletions sdk/bom/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
trigger: none

jobs:
- template: ../../eng/pipelines/templates/jobs/archetype-sdk-tests.yml
parameters:
ServiceDirectory: bom