(opendal) branch main updated: docs: Add upgrade docs for upcoming 0.52 (#5634)

[xu...@apache.org]

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 a73762718 docs: Add upgrade docs for upcoming 0.52 (#5634)
a73762718 is described below

commit a73762718d683aa7599630a7ab4b9c55020a0554
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Tue Feb 18 17:46:17 2025 +0800

    docs: Add upgrade docs for upcoming 0.52 (#5634)
    
    Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
 core/src/docs/upgrade.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/core/src/docs/upgrade.md b/core/src/docs/upgrade.md
index a5306b247..3910a3c49 100644
--- a/core/src/docs/upgrade.md
+++ b/core/src/docs/upgrade.md
@@ -1,3 +1,35 @@
+# Upgrade to v0.52
+
+## Public API
+
+### RFC-5556: Write Returns Metadata
+
+Since v0.52, all write APIs in OpenDAL have been updated to return `Metadata` instead of `()`. This metadata includes useful information provided by the service, such as `content-length`, `etag`, `version`, and `last-modified`.
+
+This feature is not fully ready yet, and many available metadata fields are still not returned. Please visit [Tracking Issues of RFC-5556: Write Returns Metadata](https://github.com/apache/opendal/issues/5557) for progress and contributions.
+
+Affected API:
+
+- `opendal::Operator::write`
+- `opendal::Operator::write_with`
+- `opendal::Operator::writer::close`
+- `opendal::raw::oio::Write::close`
+
+### Github Actions Cache (ghac) service v2
+
+As [requested](https://github.com/apache/opendal/issues/5620) by GitHub, we have upgraded our GHAC service to ensure compatibility with the latest GitHub Actions cache API.
+
+By upgrading to OpenDAL v0.52, your services will continue functioning after the deprecation of the legacy service (2025/03/01). GHES does not yet support GHAC v2, but OpenDAL has handled this properly to prevent any disruptions.
+
+ghac service doesn't support `delete` anymore, please use github's API to delete cache instead.
+
+This upgrade is mandatory and enabled by default using an environment variable in the GitHub CI environment. No changes are required at the code level.
+
+### Breaking Changes in Dependencies
+
+- `OtelTraceLayer` and `OtelMetricsLayer`'s dependence `opentelemetry` bumped to `0.28`
+- `PrometheusClientLayer`'s dependence `prometheus-client` bumped to `0.23.1`
+
 # Upgrade to v0.51
 
 ## Public API