Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(java)!: Rename artifacts id opendal-java to opendal #4957

Merged
merged 3 commits into from
Aug 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions bindings/java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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"
}
```

Expand All @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion bindings/java/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</parent>

<groupId>org.apache.opendal</groupId>
<artifactId>opendal-java</artifactId>
<artifactId>opendal</artifactId>
<version>0.46.4</version>
Xuanwo marked this conversation as resolved.
Show resolved Hide resolved

<name>Apache OpenDAL™</name>
Expand Down
24 changes: 24 additions & 0 deletions bindings/java/upgrade.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading