Skip to content
This repository has been archived by the owner on Aug 28, 2024. It is now read-only.

Commit

Permalink
upgrade version to 0.1.5, update howtocontribute.md (#120)
Browse files Browse the repository at this point in the history
* update howtocontribute

* update version to 0.1.5
  • Loading branch information
yungezz committed Aug 16, 2017
1 parent 9748b5f commit 3be5eec
Show file tree
Hide file tree
Showing 35 changed files with 50 additions and 41 deletions.
18 changes: 12 additions & 6 deletions HowToContribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ mvnw clean install
```

## Test
There're 2 profiles: `dev` and `integration-test`. Default profile is `dev`. Profile `integration-test` will trigger integration test execution.
There're 2 profiles: `dev` and `integration-test-azure`. Default profile is `dev`. Profile `integration-test-azure` will trigger integration test execution.

- Run unit tests
```bash
Expand All @@ -24,30 +24,36 @@ mvnw clean install

- Run unit tests and integration tests

>**NOTE** Please note that integration-test will automatically create a Azure Cosmos DB Document API in your Azure subscription, then there will be **Azure usage fee.**
>**NOTE** Please note that integration test will automatically create a Azure Cosmos DB Document API in your Azure subscription, then there will be **Azure usage fee.**
Integration tests will require a Azure Subscription. If you don't already have an Azure subscription, you can activate your [MSDN subscriber benefits](https://azure.microsoft.com/en-us/pricing/member-offers/msdn-benefits-details/) or sign up for a [free Azure account](https://azure.microsoft.com/en-us/free/).

1. Create a service principal by using Azure Cli or by [Azure Portal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal).
2. After service principal ready, set environment variables CLIENT_ID, CLIENT_KEY and TENANT_ID, where value of them are service principal id, key and tenant id.
3. Run maven command with `integration-test` profile.
3. Run maven command with `integration-test-azure` profile.

```bash
set CLIENT_ID=your-azure-service-principal-id
set CLIENT_KEY=your-azure-service-principal-key
set TENANT_ID=your-azure-subscription-tenant-id
mvnw -P integration-test clean install
mvnw -P integration-test-azure clean install
```

- Skip tests execution
```bash
mvnw clean install -DskipTests
```

## Version management
Developing version naming convention is like `0.1.5-beta`. Release version naming convention is like `0.1.4`. Please don't update version if no release plan.

## CI
Both [travis](https://travis-ci.org/Microsoft/azure-spring-boot-starters) and [appveyor](https://ci.appveyor.com/project/yungez/azure-spring-boot-starters) CI is enabled.

## Contribute to code
Code contribution is welcome. To contribute to existing code or add new Starter, please make sure below check list are checked.
- [ ] Build pass. checkstyle and findbugs is enabled by default.
- [ ] Build pass. checkstyle and findbugs is enabled by default. Please check [checkstyle.xml](./common/config/checkstyle.xml) to learn detail checkstyle configuration.
- [ ] Documents are updated to aligning with code.
- [ ] New starter must have sample folder contains sample code and corresponding readme file.
- [ ] Code coverage for new codes >= 65%
- [ ] Code coverage for new codes >= 65%. Code coverage check is enabled with 65% bar.

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
2 changes: 1 addition & 1 deletion cloudfoundry/azure-cloud-foundry-service-sample/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
2 changes: 1 addition & 1 deletion cloudfoundry/azure-cloud-foundry-service/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
5 changes: 4 additions & 1 deletion common/azure-spring-boot-starter-parent/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>

Expand Down Expand Up @@ -226,6 +226,9 @@
<excludes>
<exclude>com/microsoft/azure/spring/common/GetHashMac.class</exclude>
<exclude>com/microsoft/azure/**/Constants.class</exclude>
<exclude>com/microsoft/azure/**/AzureADJwtTokenFilter.class</exclude>
<exclude>com/microsoft/azure/**/AzureADGraphClient.class</exclude>
<exclude>com/microsoft/azure/**/Userprincipal.class</exclude>
</excludes>
</instrumentation>
</configuration>
Expand Down
2 changes: 1 addition & 1 deletion common/azure-spring-common/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If you are using Maven, add the following dependency.
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-documentdb-spring-boot-autoconfigure</artifactId>
<version>0.1.4</version>
<version>0.1.5</version>
</dependency>
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
@EnableConfigurationProperties(DocumentDBProperties.class)
public class DocumentDBAutoConfiguration {
private static final Logger LOG = LoggerFactory.getLogger(DocumentDBAutoConfiguration.class);
private static final String USER_AGENT_SUFFIX = "spring-boot-starter/0.1.5-beta";
private static final String USER_AGENT_SUFFIX = "spring-boot-starter/0.1.5";

private final DocumentDBProperties properties;
private final ConnectionPolicy connectionPolicy;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public class PropertySettingUtil {
public static final int MAX_POOL_SIZE = 1;
public static final int IDLE_CONNECTION_TIMEOUT = 2;
public static final String USER_AGENT_SUFFIX = "suffix";
public static final String DEFAULT_USER_AGENT_SUFFIX = "spring-boot-starter/0.1.5-beta";
public static final String DEFAULT_USER_AGENT_SUFFIX = "spring-boot-starter/0.1.5";
public static final int RETRY_OPTIONS_MAX_RETRY_ATTEMPTS_ON_THROTTLED_REQUESTS = 5;
public static final int RETRY_OPTIONS_MAX_RETRY_WAIT_TIME_IN_SECONDS = 6;
public static final boolean ENABLE_ENDPOINT_DISCOVERY = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
2 changes: 1 addition & 1 deletion documentdb/azure-documentdb-spring-boot-starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you are using Maven, add the following dependency.
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-documentdb-spring-boot-starter</artifactId>
<version>0.1.4</version>
<version>0.1.5</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion documentdb/azure-documentdb-spring-boot-starter/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion documentdb/spring-data-azure-documentdb-sample/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
2 changes: 1 addition & 1 deletion documentdb/spring-data-azure-documentdb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you are using Maven, add the following dependency.
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>spring-data-azure-documentdb</artifactId>
<version>0.1.4</version>
<version>0.1.5</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion documentdb/spring-data-azure-documentdb/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

public class DocumentDbFactory {

private static final String USER_AGENT_SUFFIX = "spring-data/0.1.5-beta";
private static final String USER_AGENT_SUFFIX = "spring-data/0.1.5";

private DocumentClient documentClient;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion keyvault/azure-keyvault-secrets-spring-boot/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<groupId>com.microsoft.azure</groupId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion microsoft-graph/spring-social-microsoft-graph/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<packaging>pom</packaging>

<name>Azure Spring Boot Starter BOM</name>
Expand Down Expand Up @@ -50,7 +50,7 @@
<spring.boot.version>1.5.4.RELEASE</spring.boot.version>
<java.version>1.8</java.version>

<bom.version>0.1.5-beta</bom.version>
<bom.version>0.1.5</bom.version>

<azure.adintegration.starter.version>${bom.version}</azure.adintegration.starter.version>
<azure.adintegration.autoconfigure.version>${bom.version}</azure.adintegration.autoconfigure.version>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
2 changes: 1 addition & 1 deletion servicebus/azure-servicebus-spring-boot-starter/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<groupId>com.microsoft.azure</groupId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion storage/azure-storage-spring-boot-autoconfigure/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion storage/azure-storage-spring-boot-starter-sample/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<dependency>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-bom</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down
2 changes: 1 addition & 1 deletion storage/azure-storage-spring-boot-starter/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.microsoft.azure</groupId>
<artifactId>azure-spring-boot-starter-parent</artifactId>
<version>0.1.5-beta</version>
<version>0.1.5</version>
<relativePath>../../common/azure-spring-boot-starter-parent/pom.xml</relativePath>
</parent>

Expand Down

0 comments on commit 3be5eec

Please sign in to comment.