Merge branch 'master' into develop

Author: mikera

BUILD.md

@@ -5,57 +5,56 @@
 Convex main repository is structured as a multi-module Maven project.
 
 
-## Build and test
-
-### Merge 
-
-- Merge from `master` branch, ensure in sync
-- Merge any other branches for release
+## Release preparation
 
 ### Ensure clean build
 
 ```
-mvn clean package
+mvn -B clean verify
 ```
 
 Remember to test headless (i.e. no GUI) e.g. with CI server.
 
-## Release preparation
-
-### Set version information
-
-First set the version number for the new version to be released
-
-```
-mvn versions:set -DnewVersion='0.8.0' -DartifactId=*  -DgroupId=*
-```
-
 ### Update CHANGELOG
 
-Need to make sure `CHANGELOG.md` is fully up to date before deploy
+Make sure `CHANGELOG.md` is fully up to date before deploy
 
 - Finalise CHANGELOG for current version
 - Annotate with date
 - Commit to release branch
 
+### Merge to master
 
-### Build and deploy
+Switch to `master` branch.
+
+Merge `develop` as a merge commit (“If a fast-forward, create a merge commit” in Eclipse)
+
+### Set version information
+
+Set the version number for the new version to be released
 
 ```
-mvn clean deploy -DperformRelease
+mvn versions:set -DnewVersion='0.8.2' -DartifactId=* -DgroupId=*
 ```
 
+Commit as "Prepare for Release 0.8.2"
+
 ### Tag release
 
-- Merge to `master` branch
-- Tag Release Commit on merge
-- Push to GitHub!
+- Tag Release Commit e.g. `0.8.2`
+
+### Build and deploy
+
+```
+mvn -B clean verify
+mvn deploy -Prelease
+```
 
 ### Prepare for next develop version
 
-- Merge `master` back into `develop`
+- Merge `master` back into `develop` (again no FF)
 - Create new CHANGELOG "Unreleased" section for next version
-- Run `mvn versions:set -DnewVersion='0.7.4-SNAPSHOT'` for next snapshot version as required 
+- Run `mvn versions:set -DnewVersion='0.8.3-SNAPSHOT'` for next snapshot version as required 
 
 ## Docker build
 

convex-benchmarks/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>world.convex</groupId>
 		<artifactId>convex</artifactId>
-		<version>0.8.2-SNAPSHOT</version>
+		<version>0.8.2</version>
 	</parent>
 
 	<modelVersion>4.0.0</modelVersion>

convex-cli/pom.xml

@@ -2,7 +2,7 @@
 	<parent>
 		<groupId>world.convex</groupId>
 		<artifactId>convex</artifactId>
-		<version>0.8.2-SNAPSHOT</version>
+		<version>0.8.2</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 

convex-core/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>world.convex</groupId>
 		<artifactId>convex</artifactId>
-		<version>0.8.2-SNAPSHOT</version>
+		<version>0.8.2</version>
 	</parent>
 
 	<properties>

convex-core/src/main/java/convex/core/data/package-info.java

@@ -3,8 +3,8 @@
  * required to implement immutable, decentralised data objects.
  * 
  * * <p>This package defines the immutable persistent data types that represent
- * all values in the CVM, including {@link CVMLong}, {@link Address}, {@link Blob},
- * {@link AVector}, {@link AMap}, etc. All classes implement the {@link ADataType}
+ * all values in the CVM, including CVMLong, Address,  Blob,
+ * AVector, AMap, etc. All classes extend the ACell
  * hierarchy and are designed for structural sharing and cryptographic hashing via CAD3 encodings.</p>
  * 
  * <p>

convex-core/src/main/java/convex/core/util/CAIP.java

@@ -71,7 +71,7 @@ public static ACell parseAssetID(AString assetID) {
 	 * Gets the asset ID for a CAD29 token from a CAPI-19 string
 	 * @param caip19 CAIP19 Format asset ID, e.g. "cad29:72"
 	 * @return CAD29 asset ID, or CONVEX_ASSET_ID constant if the String refers to CVM
-	 * @throw IllegalArgumentException if String is not a valid token ID
+	 * @throws IllegalArgumentException if String is not a valid token ID
 	 */
 	public static ACell parseTokenID(String caip19) {
 		if (isCVM(caip19)) return CONVEX_ASSET_ID;

convex-gui/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>world.convex</groupId>
 		<artifactId>convex</artifactId>
-		<version>0.8.2-SNAPSHOT</version>
+		<version>0.8.2</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 

convex-integration/pom.xml

@@ -14,7 +14,7 @@
 	<parent>
 		<groupId>world.convex</groupId>
 		<artifactId>convex</artifactId>
-		<version>0.8.2-SNAPSHOT</version>
+		<version>0.8.2</version>
 	</parent>
 
 	<build>

convex-java/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>world.convex</groupId>
 		<artifactId>convex</artifactId>
-		<version>0.8.2-SNAPSHOT</version>
+		<version>0.8.2</version>
 	</parent>
 
 	<name>Convex Java Client Library</name>

convex-observer/pom.xml

@@ -8,7 +8,7 @@
 	<parent>
 		<groupId>world.convex</groupId>
 		<artifactId>convex</artifactId>
-		<version>0.8.2-SNAPSHOT</version>
+		<version>0.8.2</version>
 	</parent>
 
 	<name>Convex Observer</name>
@@ -44,7 +44,7 @@
 		<dependency>
 			<groupId>world.convex</groupId>
 			<artifactId>convex-java</artifactId>
-			<version>0.8.2-SNAPSHOT</version>
+			<version>0.8.2</version>
 		</dependency>
 	</dependencies>
 </project>