This is an automated email from the ASF dual-hosted git repository.
asukaminato 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 0c513546f docs: Make it clear that bindings have different version
with rust core. (#6780)
0c513546f is described below
commit 0c513546fc0ef3254057526f4ea3a0d6d723dd80
Author: ChenChen Lai <[email protected]>
AuthorDate: Mon Nov 17 02:30:34 2025 +0800
docs: Make it clear that bindings have different version with rust core.
(#6780)
* docs: Make it clear that bindings have different version with rust core.
* add notice to every binding's README
---
README.md | 2 ++
bindings/README.md | 6 ++++++
bindings/c/README.md | 2 ++
bindings/cpp/README.md | 2 ++
bindings/d/README.md | 2 ++
bindings/dart/README.md | 2 ++
bindings/dotnet/README.md | 2 ++
bindings/go/README.md | 2 ++
bindings/haskell/README.md | 2 ++
bindings/java/README.md | 2 ++
bindings/lua/README.md | 2 ++
bindings/nodejs/README.md | 2 ++
bindings/ocaml/README.md | 2 ++
bindings/php/README.md | 2 ++
bindings/python/README.md | 2 ++
bindings/ruby/README.md | 2 ++
bindings/swift/README.md | 2 ++
bindings/zig/README.md | 2 ++
18 files changed, 40 insertions(+)
diff --git a/README.md b/README.md
index fe0320058..91bfc81db 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,8 @@ OpenDAL's development is guided by its vision of **One Layer,
All Storage** and
## For *ANY* languages
+> **Note**: Each binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to the specific binding's version rather than the core version.
+
| Name | Release | Docs
|
Used By |
| ----------------- | ------------------------------------------------ |
---------------------------------------------------------------------------------
| ----------------------------------- |
| [Rust Core] | [![Rust Core Image]][Rust Core Link] |
[![Docs Release]][Rust Core Release Docs] [![Docs Dev]][Rust Core Dev Docs]
| [![Rust Core Users Image]][Rust Core Users] |
diff --git a/bindings/README.md b/bindings/README.md
index 2859dcc59..f92bd422e 100644
--- a/bindings/README.md
+++ b/bindings/README.md
@@ -25,6 +25,12 @@ This folder contains the bindings for OpenDAL. Currently, we
support the followi
* [Swift](swift/README.md)
* [Zig](zig/README.md)
+## Versioning
+
+**Important**: Each binding has its own independent version number, which may
differ from the Rust core version. This allows bindings to be released and
versioned independently based on their own release cycles and compatibility
requirements.
+
+For example, while the Rust core might be at version `0.55.0`, a binding might
be at version `0.47.0` or `0.49.2`. When checking for updates or compatibility,
always refer to the specific binding's version rather than the core version.
+
## Getting Started
Every binding should provide a `README.md` file to help users get started.
diff --git a/bindings/c/README.md b/bindings/c/README.md
index c56b8c2f2..432a0cc49 100644
--- a/bindings/c/README.md
+++ b/bindings/c/README.md
@@ -4,6 +4,8 @@
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Example
A simple read and write example
diff --git a/bindings/cpp/README.md b/bindings/cpp/README.md
index 2c8a240ec..76ba7f1d1 100644
--- a/bindings/cpp/README.md
+++ b/bindings/cpp/README.md
@@ -6,6 +6,8 @@
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
Documents:
[](https://opendal.apache.org/docs/cpp/)
## Example
diff --git a/bindings/d/README.md b/bindings/d/README.md
index 9eca623b2..0d0157214 100644
--- a/bindings/d/README.md
+++ b/bindings/d/README.md
@@ -4,6 +4,8 @@
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Build
To compile OpenDAL d binding from source code, you need:
diff --git a/bindings/dart/README.md b/bindings/dart/README.md
index eefcf6a74..45e6491e2 100644
--- a/bindings/dart/README.md
+++ b/bindings/dart/README.md
@@ -1,5 +1,7 @@
# Apache OpenDAL™ Dart Binding (WIP)
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Useful Links
- [Examples](./examples)
diff --git a/bindings/dotnet/README.md b/bindings/dotnet/README.md
index fc2c8775b..a44424cb3 100644
--- a/bindings/dotnet/README.md
+++ b/bindings/dotnet/README.md
@@ -2,6 +2,8 @@
[](https://opendal.apache.org/bindings/dotnet)
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
This binding is currently under development. Please check back later.
## Build
diff --git a/bindings/go/README.md b/bindings/go/README.md
index e36559c32..3d41d1bd4 100644
--- a/bindings/go/README.md
+++ b/bindings/go/README.md
@@ -5,6 +5,8 @@
opendal-go is a **Native** support Go binding without CGO enabled and is built
on top of opendal-c.
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
```bash
go get github.com/apache/opendal/bindings/go@latest
```
diff --git a/bindings/haskell/README.md b/bindings/haskell/README.md
index 127c15c2b..a2db32f67 100644
--- a/bindings/haskell/README.md
+++ b/bindings/haskell/README.md
@@ -4,6 +4,8 @@
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Example
Basic usage
diff --git a/bindings/java/README.md b/bindings/java/README.md
index efb332f70..71a249942 100644
--- a/bindings/java/README.md
+++ b/bindings/java/README.md
@@ -6,6 +6,8 @@
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Useful Links
- [Documentation](https://opendal.apache.org/docs/java/)
diff --git a/bindings/lua/README.md b/bindings/lua/README.md
index 02b82ff42..4ec017db1 100644
--- a/bindings/lua/README.md
+++ b/bindings/lua/README.md
@@ -4,6 +4,8 @@
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Example
```lua
diff --git a/bindings/nodejs/README.md b/bindings/nodejs/README.md
index fcbd5c51e..ab2842514 100644
--- a/bindings/nodejs/README.md
+++ b/bindings/nodejs/README.md
@@ -6,6 +6,8 @@
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Useful Links
- [Documentation](https://opendal.apache.org/docs/nodejs/)
diff --git a/bindings/ocaml/README.md b/bindings/ocaml/README.md
index bbf1dfae8..4eae1d043 100644
--- a/bindings/ocaml/README.md
+++ b/bindings/ocaml/README.md
@@ -2,6 +2,8 @@
[](https://opendal.apache.org/bindings/ocaml)
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Requirements
* OCaml version > 4.03 and < 5.0.0
diff --git a/bindings/php/README.md b/bindings/php/README.md
index e54568b15..7ce2c3c3b 100644
--- a/bindings/php/README.md
+++ b/bindings/php/README.md
@@ -2,6 +2,8 @@
[](https://opendal.apache.org/bindings/php/)
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Example
```php
diff --git a/bindings/python/README.md b/bindings/python/README.md
index ad3ef3f72..22aea23f9 100644
--- a/bindings/python/README.md
+++ b/bindings/python/README.md
@@ -9,6 +9,8 @@ layer that allows you to access various storage services in a
unified way.
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Useful Links
- [Documentation](https://opendal.apache.org/docs/python/)
diff --git a/bindings/ruby/README.md b/bindings/ruby/README.md
index 11376f4d5..54d96b9b4 100644
--- a/bindings/ruby/README.md
+++ b/bindings/ruby/README.md
@@ -7,6 +7,8 @@ OpenDAL's Ruby [gem](https://rubygems.org/gems/opendal).
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
Read OpenDAL's [ruby](https://opendal.apache.org/docs/ruby/) documentation.
You can find Rust documentation
[here](https://docs.rs/opendal/latest/opendal/index.html).
diff --git a/bindings/swift/README.md b/bindings/swift/README.md
index 00d0f1213..4daa63b3c 100644
--- a/bindings/swift/README.md
+++ b/bindings/swift/README.md
@@ -4,6 +4,8 @@
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Using the Package
### Build C Dependencies
diff --git a/bindings/zig/README.md b/bindings/zig/README.md
index 0e22ce02e..6647c24f3 100644
--- a/bindings/zig/README.md
+++ b/bindings/zig/README.md
@@ -4,6 +4,8 @@
+> **Note**: This binding has its own independent version number, which may
differ from the Rust core version. When checking for updates or compatibility,
always refer to this binding's version rather than the core version.
+
## Build
To compile OpenDAL Zig binding from source code, you need:
