Skip to content

Commit 5d46ad2

Browse files
praveenkumarctpraveenkumarct
authored
Merge pull request #766 from commercetools/578-update-documentation
Update docs and Release notes about the usage of `JVM-SDK` dependencies.
2 parents d34b57a + a82b40c commit 5d46ad2

File tree

2 files changed

+72
-30
lines changed

2 files changed

+72
-30
lines changed

‎README.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,72 @@ libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "7.0.1"
8181
````xml
8282
<dependency org="com.commercetools" name="commercetools-sync-java" rev="7.0.1"/>
8383
````
84+
85+
**Note**: To avoid `commercetools JVM SDK` libraries version mismatch between projects.
86+
It is better not to add `commercetools JVM SDK` dependencies explicitly into your project and use them from `commercetools-Sync-Java` dependencies instead.
87+
Please remove them if you have already added the below dependencies in your project.
88+
89+
For Gradle users, remove:
90+
91+
````groovy
92+
implementation 'com.commercetools.sdk.jvm.core:commercetools-models:<version>'
93+
implementation 'com.commercetools.sdk.jvm.core:commercetools-java-client-ahc-2_5:<version>'
94+
implementation 'com.commercetools.sdk.jvm.core:commercetools-convenience:<version>'
95+
````
96+
97+
For Maven users, remove:
98+
99+
````xml
100+
<dependency>
101+
<groupId>com.commercetools.sdk.jvm.core</groupId>
102+
<artifactId>commercetools-models</artifactId>
103+
<version>version</version>
104+
</dependency>
105+
<dependency>
106+
<groupId>com.commercetools.sdk.jvm.core</groupId>
107+
<artifactId>commercetools-java-client-ahc-2_5</artifactId>
108+
<version>version</version>
109+
</dependency>
110+
<dependency>
111+
<groupId>com.commercetools.sdk.jvm.core</groupId>
112+
<artifactId>commercetools-convenience</artifactId>
113+
<version>version</version>
114+
</dependency>
115+
````
116+
117+
If you want to use a different `commercetools JVM SDK` version than the version used in this project.
118+
, below you will find examples on how to exclude `commercetools JVM SDK` from commercetools-sync-java library. Beware that library might not work with the older `commercetools JVM SDK` versions.
119+
120+
For Gradle:
121+
122+
````groovy
123+
implementation('com.commercetools:commercetools-sync-java') {
124+
exclude group: 'com.commercetools.sdk.jvm.core', module: 'commercetools-models'
125+
exclude group: 'com.commercetools.sdk.jvm.core', module: 'commercetools-java-client-ahc-2_5'
126+
exclude group: 'com.commercetools.sdk.jvm.core', module: 'commercetools-convenience'
127+
}
128+
````
129+
130+
For Maven:
131+
132+
````xml
133+
<dependency>
134+
<groupId>com.commercetools</groupId>
135+
<artifactId>commercetools-sync-java</artifactId>
136+
<version>version</version>
137+
<exclusions>
138+
<exclusion>
139+
<groupId>com.commercetools.sdk.jvm.core</groupId>
140+
<artifactId>commercetools-models</artifactId>
141+
</exclusion>
142+
<exclusion>
143+
<groupId>com.commercetools.sdk.jvm.core</groupId>
144+
<artifactId>commercetools-java-client-ahc-2_5</artifactId>
145+
</exclusion>
146+
<exclusion>
147+
<groupId>com.commercetools.sdk.jvm.core</groupId>
148+
<artifactId>commercetools-convenience</artifactId>
149+
</exclusion>
150+
</exclusions>
151+
</dependency>
152+
````

‎docs/RELEASE_NOTES.md‎

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -42,37 +42,10 @@
4242
[Jar](https://search.maven.org/artifact/com.commercetools/commercetools-sync-java/7.0.0/jar)
4343

4444
- 🚧 **Breaking Changes** (1)
45-
- **Dependency management:** Avoid `commercetools JVM SDK` libraries version mismatch between projects.
46-
It is better not to add `commercetools JVM SDK` dependencies explicitly into your project and use them from `commercetools-Sync-Java` dependencies instead. Please remove them if you have already added the below dependencies in your project.
45+
- **Dependency management:** To avoid `commercetools JVM SDK` libraries version mismatch between projects.
46+
It is better not to add `commercetools JVM SDK` dependencies explicitly into your project and use them from `commercetools-Sync-Java` dependencies instead.
47+
Check [README.md](https://github.com/commercetools/commercetools-sync-java#installation) for more details.
4748

48-
For Gradle users, remove:
49-
50-
````groovy
51-
implementation 'com.commercetools.sdk.jvm.core:commercetools-models:<version>'
52-
implementation 'com.commercetools.sdk.jvm.core:commercetools-java-client-ahc-2_5:<version>'
53-
implementation 'com.commercetools.sdk.jvm.core:commercetools-convenience:<version>'
54-
````
55-
56-
For Maven users, remove:
57-
58-
````xml
59-
<dependency>
60-
<groupId>com.commercetools.sdk.jvm.core</groupId>
61-
<artifactId>commercetools-models</artifactId>
62-
<version>version</version>
63-
</dependency>
64-
<dependency>
65-
<groupId>com.commercetools.sdk.jvm.core</groupId>
66-
<artifactId>commercetools-java-client-ahc-2_5</artifactId>
67-
<version>version</version>
68-
</dependency>
69-
<dependency>
70-
<groupId>com.commercetools.sdk.jvm.core</groupId>
71-
<artifactId>commercetools-convenience</artifactId>
72-
<version>version</version>
73-
</dependency>
74-
````
75-
7649
✨ **Documentation** (1)
7750
- Usage documentation on main readme improved, obsolete links is removed. [#758](https://github.com/commercetools/commercetools-sync-java/pull/758)
7851

0 commit comments

Comments
 (0)