Skip to content

Commit 120d4de

Browse files
authored
bump documentation versions and add release note for 8.1.0. (#801)
1 parent 2363de8 commit 120d4de

17 files changed

Lines changed: 64 additions & 38 deletions

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# commercetools sync
33
[![CI](https://github.com/commercetools/commercetools-sync-java/workflows/CI/badge.svg)](https://github.com/commercetools/commercetools-sync-java/actions?query=workflow%3ACI)
44
[![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
5-
[![Benchmarks 8.0.0](https://img.shields.io/badge/Benchmarks-8.0.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
6-
[![Download from Maven Central](https://img.shields.io/badge/Maven_Central-8.0.0-blue.svg)](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/8.0.0/jar)
7-
[![Javadoc](https://javadoc.io/badge2/com.commercetools/commercetools-sync-java/javadoc.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/)
5+
[![Benchmarks 8.1.0](https://img.shields.io/badge/Benchmarks-8.1.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
6+
[![Download from Maven Central](https://img.shields.io/badge/Maven_Central-8.1.0-blue.svg)](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/8.1.0/jar)
7+
[![Javadoc](https://javadoc.io/badge2/com.commercetools/commercetools-sync-java/javadoc.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/)
88
[![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)
99

1010
More at https://commercetools.github.io/commercetools-sync-java
@@ -25,7 +25,7 @@ Supported resources: [Categories](/docs/usage/CATEGORY_SYNC.md), [Products](/doc
2525
- [SBT](#sbt)
2626
- [Ivy](#ivy)
2727
- [Release Notes](/docs/RELEASE_NOTES.md)
28-
- [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/)
28+
- [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/)
2929
- [Benchmarks](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
3030

3131
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -60,26 +60,26 @@ Here are the most popular ones:
6060
<dependency>
6161
<groupId>com.commercetools</groupId>
6262
<artifactId>commercetools-sync-java</artifactId>
63-
<version>8.0.0</version>
63+
<version>8.1.0</version>
6464
</dependency>
6565
````
6666

6767
#### Gradle
6868

6969
````groovy
70-
implementation 'com.commercetools:commercetools-sync-java:8.0.0'
70+
implementation 'com.commercetools:commercetools-sync-java:8.1.0'
7171
````
7272

7373
#### SBT
7474

7575
````
76-
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "8.0.0"
76+
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "8.1.0"
7777
````
7878

7979
#### Ivy
8080

8181
````xml
82-
<dependency org="com.commercetools" name="commercetools-sync-java" rev="8.0.0"/>
82+
<dependency org="com.commercetools" name="commercetools-sync-java" rev="8.1.0"/>
8383
````
8484

8585
**Note**: To avoid `commercetools JVM SDK` libraries version mismatch between projects.

docs/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# commercetools sync
33
[![CI](https://github.com/commercetools/commercetools-sync-java/workflows/CI/badge.svg)](https://github.com/commercetools/commercetools-sync-java/actions?query=workflow%3ACI)
44
[![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
5-
[![Benchmarks 8.0.0](https://img.shields.io/badge/Benchmarks-8.0.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
6-
[![Download from Maven Central](https://img.shields.io/badge/Maven_Central-8.0.0-blue.svg)](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/8.0.0/jar)
7-
[![Javadoc](https://javadoc.io/badge2/com.commercetools/commercetools-sync-java/javadoc.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/)
5+
[![Benchmarks 8.1.0](https://img.shields.io/badge/Benchmarks-8.1.0-orange.svg)](https://commercetools.github.io/commercetools-sync-java/benchmarks/)
6+
[![Download from Maven Central](https://img.shields.io/badge/Maven_Central-8.1.0-blue.svg)](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/8.1.0/jar)
7+
[![Javadoc](https://javadoc.io/badge2/com.commercetools/commercetools-sync-java/javadoc.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/)
88
[![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)
99

1010

@@ -40,18 +40,18 @@ Here are the most popular ones:
4040
<dependency>
4141
<groupId>com.commercetools</groupId>
4242
<artifactId>commercetools-sync-java</artifactId>
43-
<version>8.0.0</version>
43+
<version>8.1.0</version>
4444
</dependency>
4545
````
4646
#### Gradle
4747
````groovy
48-
implementation 'com.commercetools:commercetools-sync-java:8.0.0'
48+
implementation 'com.commercetools:commercetools-sync-java:8.1.0'
4949
````
5050
#### SBT
5151
````
52-
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "8.0.0"
52+
libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "8.1.0"
5353
````
5454
#### Ivy
5555
````xml
56-
<dependency org="com.commercetools" name="commercetools-sync-java" rev="8.0.0"/>
56+
<dependency org="com.commercetools" name="commercetools-sync-java" rev="8.1.0"/>
5757
````

docs/RELEASE_NOTES.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,32 @@
2626
2727
7. Add Migration guide section which specifies explicitly if there are breaking changes and how to tackle them.
2828
-->
29+
30+
### 8.1.0 - Dec 14, 2021
31+
[Commits](https://github.com/commercetools/commercetools-sync-java/compare/8.0.0...8.1.0) |
32+
[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/) |
33+
[Jar](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/8.1.0/jar)
34+
35+
-**Build Tools**
36+
- Migrated from gradle `v6.8.2` to [`v7.3.1`](https://togithub.com/gradle/gradle/releases/v7.3.1).
37+
- Migrated github actions `setup-java` plugin from `v1` to [`v2`](https://togithub.com/actions/setup-java/compare/v1...v2)
38+
- Migrated github actions `codecov-action` plugin from `v1` to [`v2`](https://togithub.com/codecov/codecov-action/compare/v1...v2)
39+
40+
- 🛠️ **Dependency Updates**
41+
- `commercetools-jvm-sdk` `1.64.0` -> [`2.5.0`](http://commercetools.github.io/commercetools-jvm-sdk/apidocs/io/sphere/sdk/meta/ReleaseNotes.html#v2.5.0)
42+
- `com.adarshr.test-logger` `3.0.0` -> [`3.1.0`](https://github.com/radarsh/gradle-test-logger-plugin/releases/tag/v3.1.0)
43+
- `ru.vyarus.mkdocs` `2.1.2` -> [`2.2.0`](https://github.com/xvik/gradle-mkdocs-plugin/releases/tag/2.2.0)
44+
- `org.ajoberstar.grgit` `4.1.0` -> [`4.1.1`](https://github.com/ajoberstar/grgit/releases/tag/4.1.1)
45+
- `com.github.spotbugs` `4.7.1` -> [`5.0.2`](https://github.com/spotbugs/spotbugs-gradle-plugin/releases/tag/5.0.2)
46+
- `com.diffplug.spotless` `5.14.2` -> `6.0.4`
47+
- `mockito-junit-jupiter` `3.11.2` -> [`4.1.0`](https://github.com/mockito/mockito/releases/tag/v4.1.0)
48+
- `org.junit.jupiter:junit-jupiter-api` `5.7.2` -> [`5.8.2`](https://junit.org/junit5/docs/snapshot/release-notes/index.html#release-notes-5.8.2)
49+
- `org.junit.jupiter:junit-jupiter-engine` `5.7.2` -> [`5.8.2`](https://junit.org/junit5/docs/snapshot/release-notes/index.html#release-notes-5.8.2)
50+
- `org.junit.jupiter:junit-jupiter-params` `5.7.2` -> [`5.8.2`](https://junit.org/junit5/docs/snapshot/release-notes/index.html#release-notes-5.8.2)
51+
- `org.assertj.assertj-core` `3.20.2` -> [`3.21.0`](https://assertj.github.io/doc/#assertj-core-3-21-0-release-notes)
52+
- `com.github.ben-manes.caffeine` `2.9.2` -> [`2.9.3`](https://github.com/ben-manes/caffeine/releases/tag/v2.9.3)
53+
- (new) `org.apache.commons:common-text` [`1.9`](https://commons.apache.org/proper/commons-text/changes-report.html#a1.9)
54+
2955
### 8.0.0 - Oct 1, 2021
3056
[Commits](https://github.com/commercetools/commercetools-sync-java/compare/7.0.2...8.0.0) |
3157
[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/) |

docs/usage/CART_DISCOUNT_SYNC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ against a [CartDiscountDraft](https://docs.commercetools.com/http-api-projects-c
3636

3737
#### SphereClient
3838

39-
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.0.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
39+
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.1.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
4040
If you have custom requirements for the sphere client creation, have a look into the [Important Usage Tips](IMPORTANT_USAGE_TIPS.md).
4141

4242
````java
@@ -67,7 +67,7 @@ Therefore, in order to resolve the actual ids of those references in the sync pr
6767
6868
##### Syncing from a commercetools project
6969

70-
When syncing from a source commercetools project, you can use [`toCartDiscountDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/com/commercetools/sync/cartdiscounts/utils/CartDiscountTransformUtils.html#toCartDiscountDrafts-java.util.List-)
70+
When syncing from a source commercetools project, you can use [`toCartDiscountDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/com/commercetools/sync/cartdiscounts/utils/CartDiscountTransformUtils.html#toCartDiscountDrafts-java.util.List-)
7171
method that transforms(resolves by querying and caching key-id pairs) and maps from a `CartDiscount` to `CartDiscountDraft` using cache in order to make them ready for reference resolution by the sync, for example:
7272

7373
````java

docs/usage/CATEGORY_SYNC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ against a [CategoryDraft](https://docs.commercetools.com/http-api-projects-categ
3636

3737
#### SphereClient
3838

39-
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.0.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
39+
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.1.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
4040
If you have custom requirements for the sphere client creation, have a look into the [Important Usage Tips](IMPORTANT_USAGE_TIPS.md).
4141

4242
````java
@@ -135,7 +135,7 @@ As soon, as the referenced parent Category draft is supplied to the sync, the dr
135135

136136
##### Syncing from a commercetools project
137137

138-
When syncing from a source commercetools project, you can use [`toCategoryDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/com/commercetools/sync/categories/utils/CategoryTransformUtils.html#toCategoryDrafts-java.util.List-)
138+
When syncing from a source commercetools project, you can use [`toCategoryDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/com/commercetools/sync/categories/utils/CategoryTransformUtils.html#toCategoryDrafts-java.util.List-)
139139
method that transforms(resolves by querying and caching key-id pairs) and maps from a `Category` to `CategoryDraft` using cache in order to make them ready for reference resolution by the sync, for example:
140140

141141
````java

docs/usage/CUSTOMER_SYNC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ against a [CustomerDraft](https://docs.commercetools.com/api/projects/customers#
3535
### Prerequisites
3636
#### SphereClient
3737

38-
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.0.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
38+
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.1.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
3939
If you have custom requirements for the sphere client creation, have a look into the [Important Usage Tips](IMPORTANT_USAGE_TIPS.md).
4040

4141
````java
@@ -69,7 +69,7 @@ Therefore, in order to resolve the actual ids of those references in the sync pr
6969
7070
##### Syncing from a commercetools project
7171

72-
When syncing from a source commercetools project, you can use [`toCustomerDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/com/commercetools/sync/customers/utils/CustomerTransformUtils.html#toCustomerDrafts-java.util.List-)
72+
When syncing from a source commercetools project, you can use [`toCustomerDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/com/commercetools/sync/customers/utils/CustomerTransformUtils.html#toCustomerDrafts-java.util.List-)
7373
method that transforms(resolves by querying and caching key-id pairs) and maps from a `Customer` to `CustomerDraft` using cache in order to make them ready for reference resolution by the sync, for example:
7474

7575
````java

docs/usage/CUSTOM_OBJECT_SYNC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ against a [CustomObjectDraft](https://docs.commercetools.com/http-api-projects-c
3131

3232
#### SphereClient
3333

34-
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.0.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
34+
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.1.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
3535
If you have custom requirements for the sphere client creation, have a look into the [Important Usage Tips](IMPORTANT_USAGE_TIPS.md).
3636

3737
````java

docs/usage/IMPORTANT_USAGE_TIPS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ productSync.sync(batch1)
3131
By design, scaling the sync process should **not** be done by executing the batches themselves in parallel. However, it can be done either by:
3232

3333
- Changing the number of [max parallel requests](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L116) within the `sphereClient` configuration. It defines how many requests the client can execute in parallel.
34-
- or changing the draft [batch size](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/com/commercetools/sync/commons/BaseSyncOptionsBuilder.html#batchSize-int-). It defines how many drafts can one batch contains.
34+
- or changing the draft [batch size](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/com/commercetools/sync/commons/BaseSyncOptionsBuilder.html#batchSize-int-). It defines how many drafts can one batch contains.
3535

3636
The current overridable default [configuration](https://github.com/commercetools/commercetools-sync-java/tree/master/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) of the `sphereClient`
3737
is the recommended good balance for stability and performance for the sync process.

docs/usage/INVENTORY_SYNC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ against a [InventoryEntryDraft](https://docs.commercetools.com/http-api-projects
3636

3737
#### SphereClient
3838

39-
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.0.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
39+
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.1.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
4040
If you have custom requirements for the sphere client creation, have a look into the [Important Usage Tips](IMPORTANT_USAGE_TIPS.md).
4141

4242
````java
@@ -68,7 +68,7 @@ Therefore, in order to resolve the actual ids of those references in the sync pr
6868
6969
##### Syncing from a commercetools project
7070

71-
When syncing from a source commercetools project, you can use [`toInventoryEntryDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/com/commercetools/sync/inventories/utils/InventoryTransformUtils.html#toInventoryEntryDrafts-java.util.List-)
71+
When syncing from a source commercetools project, you can use [`toInventoryEntryDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/com/commercetools/sync/inventories/utils/InventoryTransformUtils.html#toInventoryEntryDrafts-java.util.List-)
7272
method that transforms(resolves by querying and caching key-id pairs) and maps from a `InventoryEntry` to `InventoryEntryDraft` using cache in order to make them ready for reference resolution by the sync, for example:
7373

7474
````java

docs/usage/PRODUCT_SYNC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ against a [ProductDraft](https://docs.commercetools.com/http-api-projects-produc
3939

4040
#### SphereClient
4141

42-
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.0.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
42+
Use the [ClientConfigurationUtils](https://github.com/commercetools/commercetools-sync-java/blob/8.1.0/src/main/java/com/commercetools/sync/commons/utils/ClientConfigurationUtils.java#L45) which apply the best practices for `SphereClient` creation.
4343
If you have custom requirements for the sphere client creation, have a look into the [Important Usage Tips](IMPORTANT_USAGE_TIPS.md).
4444

4545
````java
@@ -80,7 +80,7 @@ resource on the target commercetools project and the library will issue an updat
8080

8181
##### Syncing from a commercetools project
8282

83-
When syncing from a source commercetools project, you can use [`toProductDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.0.0/com/commercetools/sync/products/utils/ProductTransformUtils.html#toProductDrafts-java.util.List-)
83+
When syncing from a source commercetools project, you can use [`toProductDrafts`](https://commercetools.github.io/commercetools-sync-java/v/8.1.0/com/commercetools/sync/products/utils/ProductTransformUtils.html#toProductDrafts-java.util.List-)
8484
method that transforms(resolves by querying and caching key-id pairs) and maps from a `Product` to `ProductDraft` using cache in order to make them ready for reference resolution by the sync, for example:
8585

8686
````java

0 commit comments

Comments
 (0)