Merge pull request #629 from commercetools/shopping-lists-base-branch

Prepare release 3.0.0
commercetools · Nov 18, 2020 · d05cc21 · d05cc21
2 parents 38623bb + 3ef430e
commit d05cc21
Show file tree

Hide file tree

Showing 91 changed files with 13,353 additions and 232 deletions.
diff --git a/.adr-dir b/.adr-dir
@@ -0,0 +1 @@
+docs/adr
diff --git a/README.md b/README.md
@@ -2,9 +2,9 @@
 # commercetools sync
 [![Build Status](https://travis-ci.org/commercetools/commercetools-sync-java.svg?branch=master)](https://travis-ci.org/commercetools/commercetools-sync-java)
 [![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
-[![Benchmarks 2.3.0](https://img.shields.io/badge/Benchmarks-2.3.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
+[![Benchmarks 3.0.0](https://img.shields.io/badge/Benchmarks-3.0.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
 [![Download](https://api.bintray.com/packages/commercetools/maven/commercetools-sync-java/images/download.svg) ](https://bintray.com/commercetools/maven/commercetools-sync-java/_latestVersion)
-[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/2.3.0/)
+[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/3.0.0/)
 [![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)
 
 More at https://commercetools.github.io/commercetools-sync-java
@@ -23,6 +23,7 @@ The library supports synchronising the following entities in commercetools
  - [TaxCategories](/docs/usage/TAX_CATEGORY_SYNC.md)
  - [CustomObjects](/docs/usage/CUSTOM_OBJECT_SYNC.md)
  - [Customers](/docs/usage/CUSTOMER_SYNC.md)
+ - [ShoppingLists](/docs/usage/SHOPPING_LIST_SYNC.md)
 
 
 ![commercetools-java-sync-final 001](https://user-images.githubusercontent.com/9512131/31230702-0f2255a6-a9e5-11e7-9412-04ed52641dde.png)
@@ -39,7 +40,7 @@ The library supports synchronising the following entities in commercetools
     - [Ivy](#ivy)
 - [Roadmap](#roadmap)
 - [Release Notes](/docs/RELEASE_NOTES.md)
-- [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/2.3.0/)
+- [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/3.0.0/)
 - [Benchmarks](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -66,7 +67,7 @@ commercetools sync is a Java library that imports commercetools platform data in
 
  - Make sure you have `JDK 8` installed.
  - [commercetools-jvm-sdk](https://github.com/commercetools/commercetools-jvm-sdk) as a dependency in your JVM-based 
-  application. (Make sure to use a version `>= 1.53.0`).
+  application. (Make sure to use a version `>= 1.54.0`).
  - a target commercetools project for syncing your source data to.
 
 
@@ -81,28 +82,24 @@ Here are the most popular ones:
 <dependency>
   <groupId>com.commercetools</groupId>
   <artifactId>commercetools-sync-java</artifactId>
-  <version>2.3.0</version>
+  <version>3.0.0</version>
 </dependency>
 ````
 
 #### Gradle
 
 ````groovy
-implementation 'com.commercetools:commercetools-sync-java:2.3.0'
+implementation 'com.commercetools:commercetools-sync-java:3.0.0'
 ````
 
 #### SBT 
 
 ````
-libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "2.3.0"
+libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "3.0.0"
 ````
 
 #### Ivy 
 
 ````xml
-<dependency org="com.commercetools" name="commercetools-sync-java" rev="2.3.0"/>
+<dependency org="com.commercetools" name="commercetools-sync-java" rev="3.0.0"/>
 ````
-
-
-## Roadmap
-https://github.com/commercetools/commercetools-sync-java/milestones
diff --git a/docs/README.md b/docs/README.md
@@ -2,9 +2,9 @@
 # commercetools sync
 [![Build Status](https://travis-ci.org/commercetools/commercetools-sync-java.svg?branch=master)](https://travis-ci.org/commercetools/commercetools-sync-java)
 [![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
-[![Benchmarks 2.3.0](https://img.shields.io/badge/Benchmarks-2.3.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
+[![Benchmarks 3.0.0](https://img.shields.io/badge/Benchmarks-3.0.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
 [![Download](https://api.bintray.com/packages/commercetools/maven/commercetools-sync-java/images/download.svg) ](https://bintray.com/commercetools/maven/commercetools-sync-java/_latestVersion)
-[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/2.3.0/)
+[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/3.0.0/)
 [![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)
 
 
@@ -37,6 +37,7 @@ The library supports synchronising the following entities in commercetools
  - [TaxCategories](/docs/usage/TAX_CATEGORY_SYNC.md)
  - [CustomObjects](/docs/usage/CUSTOM_OBJECT_SYNC.md)
  - [Customers](/docs/usage/CUSTOMER_SYNC.md)
+ - [ShoppingLists](/docs/usage/SHOPPING_LIST_SYNC.md)
 
 ![commercetools-java-sync-final 001](https://user-images.githubusercontent.com/9512131/31230702-0f2255a6-a9e5-11e7-9412-04ed52641dde.png)
 
@@ -45,7 +46,7 @@ The library supports synchronising the following entities in commercetools
 
  - Make sure you have `JDK 8` installed.
  - [commercetools-jvm-sdk](https://github.com/commercetools/commercetools-jvm-sdk) as a dependency in your JVM-based 
-  application. (Make sure to use a version `>= 1.47.0`).
+  application. (Make sure to use a version `>= 1.54.0`).
  - a target commercetools project for syncing your source data to.
 
 
@@ -57,18 +58,18 @@ Here are the most popular ones:
 <dependency>
   <groupId>com.commercetools</groupId>
   <artifactId>commercetools-sync-java</artifactId>
-  <version>2.3.0</version>
+  <version>3.0.0</version>
 </dependency>
 ````
 #### Gradle
 ````groovy
-implementation 'com.commercetools:commercetools-sync-java:2.3.0'
+implementation 'com.commercetools:commercetools-sync-java:3.0.0'
 ````
 #### SBT 
 ````
-libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "2.3.0"
+libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "3.0.0"
 ````
 #### Ivy 
 ````xml
-<dependency org="com.commercetools" name="commercetools-sync-java" rev="2.3.0"/>
+<dependency org="com.commercetools" name="commercetools-sync-java" rev="3.0.0"/>
 ````
diff --git a/docs/RELEASE_NOTES.md b/docs/RELEASE_NOTES.md
@@ -26,15 +26,30 @@
 
 7. Add Migration guide section which specifies explicitly if there are breaking changes and how to tackle them.
 
-### 3.0.0 - MMM DD, 2020
-[Commits](https://github.com/commercetools/commercetools-sync-java/compare/2.3.0...2.4.0) |
-[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/2.4.0/) |
-[Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/2.4.0)
+-->
+
+### 3.0.0 - Nov 18, 2020
+[Commits](https://github.com/commercetools/commercetools-sync-java/compare/2.3.0...3.0.0) |
+[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/3.0.0/) |
+[Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/3.0.0)
 
 - 🚧 **Breaking Changes** (1)
     - **Product Sync**: `ProductDraft.getState()` is changed from `Reference<State>` to `ResourceIdentifier<State>`, so as a library user you don't need to provide a key field in the id field of the Reference. (Now API and JVM SDK support `ResourceIdentifiers` and it supports id or key as a field). [#589](https://github.com/commercetools/commercetools-sync-java/pull/589)
 
--->
+- 🐞 **Bug Fixes** (1)
+    - **Commons** - Fixed a bug in the duration calculation of decorated retry sphere client `RetrySphereClientDecorator` created by `ClientConfigurationUtils`. [#610](https://github.com/commercetools/commercetools-sync-java/issues/610)
+
+- 🎉 **New Features** (4)
+    - **ShoppingList Sync** - Added support for syncing shopping lists between ctp projects. [#594](https://github.com/commercetools/commercetools-sync-java/issues/594)
+    - **ShoppingList Sync** - Introduced `ShoppingListSyncUtils` which calculates all needed update actions after comparing a `ShoppingList` and a `ShoppingListDraft`. [#594](https://github.com/commercetools/commercetools-sync-java/issues/594)
+    - **ShoppingList Sync** - Introduced `ShoppingListUpdateActionUtils` which contains utils for calculating necessary update actions after comparing individual fields of a `ShoppingList` and a `ShoppingListDraft`. [#594](https://github.com/commercetools/commercetools-sync-java/issues/594)
+    - **ShoppingList Sync** - Introduced `ShoppingListReferenceResolutionUtils` which resolves Type references from a ShoppingList to a ShoppingListDraft. [#594](https://github.com/commercetools/commercetools-sync-java/issues/594)
+
+- 🛠️ **Dependency Updates** (1)
+    - `commercetools-jvm-sdk` `1.53.0` -> [`1.54.0`](http://commercetools.github.io/commercetools-jvm-sdk/apidocs/io/sphere/sdk/meta/ReleaseNotes.html#v1_54_0)
+    - `mockito-junit-jupiter` `3.5.13` ->  [`3.6.0`](https://github.com/mockito/mockito/releases/tag/v3.6.0) 
+    - `org.assertj.assertj-core` `3.17.2` ->  [`3.18.1`](https://assertj.github.io/doc/#assertj-core-3-18-1-release-notes)
+
 ### 2.3.0 - Oct 15, 2020
 [Commits](https://github.com/commercetools/commercetools-sync-java/compare/2.2.1...2.3.0) |
 [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/2.3.0/) |

diff --git a/docs/adr/0001-record-architecture-decisions.md b/docs/adr/0001-record-architecture-decisions.md
@@ -0,0 +1,19 @@
+# 1. Record architecture decisions
+
+Date: 2020-11-04
+
+## Status
+
+Accepted
+
+## Context
+
+We need to record the architectural decisions made on this project.
+
+## Decision
+
+We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
+
+## Consequences
+
+See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).