Skip to content

Commit

Permalink
Update version strategy for these packages.
Browse files Browse the repository at this point in the history
  • Loading branch information
Junyi Yi committed Aug 9, 2017
1 parent d33dd04 commit b89349d
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 4 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,23 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
* "Ignore optional compiler problems" in "Java Build Path" for "target/generated-sources/\*\*/\*.java"

# Coding Convention

## Version Management

Out version strategy just follows the maven package version convention: `<major>.<minor>.<hotfix>-<prerelease>`, where:

* `<major>`: Increasing when incompatible breaking changes happened
* `<minor>`: Increasing when new features added
* `<hotfix>`: Increasing when a hotfix is pushed
* `<prerelease>`: A string representing a pre-release version

**Use `SNAPSHOT` pre-release tag for packages under development**. Here is the sample workflow:

1. Initially the package version is `1.0-SNAPSHOT`. *There is no hotfix for SNAPSHOT*
2. Modify the version to `1.0.0-ALPHA` for internal testing purpose. *Notice the hotfix exists here*
3. After several BUG fixes, update the version to `1.0.0`.
4. Create a new development version `1.1-SNAPSHOT`.
5. Make a new hotfix into `1.0-SNAPSHOT`, and release to version `1.0.1`.
6. New features are added to `1.1-SNAPSHOT`.

Every time you release a non-development version (like `1.0.0-ALPHA` or `1.0.1`), you also need to update the tag in your git repository.
2 changes: 1 addition & 1 deletion azure-functions-java-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<groupId>com.microsoft.azure.serverless</groupId>
<artifactId>azure-functions-java-core</artifactId>
<packaging>jar</packaging>
<version>1.0.0</version>
<version>1.0-SNAPSHOT</version>
<url>http://maven.apache.org</url>

<properties>
Expand Down
2 changes: 1 addition & 1 deletion azure-functions-java-sample/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.microsoft.serverless</groupId>
<artifactId>azure-functions-java-sample</artifactId>
<version>1.0</version>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>com.microsoft.azure.serverless</groupId>
Expand Down
2 changes: 1 addition & 1 deletion azure-functions-java-worker/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.microsoft.azure.serverless</groupId>
<artifactId>azure-functions-java-worker</artifactId>
<version>1.0.0</version>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>

<name>Microsoft Azure Functions Java Runtime</name>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.microsoft.azure.serverless</groupId>
<artifactId>azure-functions-java-runtime-solution</artifactId>
<version>1.0.0</version>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
<url>http://maven.apache.org</url>
<modules>
Expand Down

0 comments on commit b89349d

Please sign in to comment.