This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git
The following commit(s) were added to refs/heads/main by this push:
new fac74d488b refactor(java)!: Rename artifacts id opendal-java to
opendal (#4957)
fac74d488b is described below
commit fac74d488ba82181330510f52be97f1338408878
Author: Xuanwo <[email protected]>
AuthorDate: Sat Aug 3 11:31:36 2024 +0800
refactor(java)!: Rename artifacts id opendal-java to opendal (#4957)
* refactor(java)!: Rename artifacts id opendal-java to opendal
Signed-off-by: Xuanwo <[email protected]>
* add upgrade items
Signed-off-by: Xuanwo <[email protected]>
* Fix typo
Signed-off-by: Xuanwo <[email protected]>
---------
Signed-off-by: Xuanwo <[email protected]>
---
bindings/java/README.md | 14 +++++++-------
bindings/java/pom.xml | 2 +-
bindings/java/upgrade.md | 24 ++++++++++++++++++++++++
3 files changed, 32 insertions(+), 8 deletions(-)
diff --git a/bindings/java/README.md b/bindings/java/README.md
index 7f4c2ef418..73b27d9676 100644
--- a/bindings/java/README.md
+++ b/bindings/java/README.md
@@ -47,18 +47,18 @@ Generally, you can first add the `os-maven-plugin` for
automatically detect the
</build>
```
-Then add the dependency to `opendal-java` as following:
+Then add the dependency to `opendal` as following:
```xml
<dependencies>
<dependency>
<groupId>org.apache.opendal</groupId>
- <artifactId>opendal-java</artifactId>
+ <artifactId>opendal</artifactId>
<version>${opendal.version}</version>
</dependency>
<dependency>
<groupId>org.apache.opendal</groupId>
- <artifactId>opendal-java</artifactId>
+ <artifactId>opendal</artifactId>
<version>${opendal.version}</version>
<classifier>${os.detected.classifier}</classifier>
</dependency>
@@ -75,12 +75,12 @@ plugins {
}
```
-Then add the dependency to `opendal-java` as following:
+Then add the dependency to `opendal as following:
```groovy
dependencies {
- implementation "org.apache.opendal:opendal-java:$opendalVersion"
- implementation
"org.apache.opendal:opendal-java:$opendalVersion:$osdetector.classifier"
+ implementation "org.apache.opendal:opendal:$opendalVersion"
+ implementation
"org.apache.opendal:opendal:$opendalVersion:$osdetector.classifier"
}
```
@@ -101,7 +101,7 @@ To load the shared library correctly, you can choose one of
the following approa
## Build
-This project provides OpenDAL Java bindings with artifact name `opendal-java`.
It depends on JDK 8 or later.
+This project provides OpenDAL Java bindings with artifact name `opendal`. It
depends on JDK 8 or later.
You can use Maven to build both Rust dynamic lib and JAR files with one
command now:
diff --git a/bindings/java/pom.xml b/bindings/java/pom.xml
index a974f7509c..11cf045a89 100644
--- a/bindings/java/pom.xml
+++ b/bindings/java/pom.xml
@@ -31,7 +31,7 @@
</parent>
<groupId>org.apache.opendal</groupId>
- <artifactId>opendal-java</artifactId>
+ <artifactId>opendal</artifactId>
<version>0.46.4</version>
<name>Apache OpenDAL™</name>
diff --git a/bindings/java/upgrade.md b/bindings/java/upgrade.md
index 88631c837e..5d1e196615 100644
--- a/bindings/java/upgrade.md
+++ b/bindings/java/upgrade.md
@@ -1,3 +1,27 @@
+# Upgrade to v0.47
+
+## Breaking change
+
+artifactId of the `opendal-java` has changed from to `opendal` to align with
the convention of entire OpenDAL project.
+
+```diff
+<dependencies>
+<dependency>
+ <groupId>org.apache.opendal</groupId>
+- <artifactId>opendal-java</artifactId>
++ <artifactId>opendal</artifactId>
+ <version>${opendal.version}</version>
+</dependency>
+<dependency>
+ <groupId>org.apache.opendal</groupId>
+- <artifactId>opendal-java</artifactId>
++ <artifactId>opendal</artifactId>
+ <version>${opendal.version}</version>
+ <classifier>${os.detected.classifier}</classifier>
+</dependency>
+</dependencies>
+```
+
# Upgrade to v0.46
## Breaking change
