Skip to content
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
Empty file removed docs/rust-client.md
Empty file.
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
sidebar_position: 4
---

# Creating a Fluss Rust Client Release

This document describes in detail how to create a release of the **Fluss clients** (fluss-rust, fluss-python, fluss-cpp) from the [fluss-rust](https://github.com/apache/fluss-rust) repository. It is based on the [Creating a Fluss Release](https://fluss.apache.org/community/how-to-release/creating-a-fluss-release/) guide of the Apache Fluss project and the [release guide of Apache OpenDAL](https://nightlies.apache.org/opendal/opendal-docs-stable/community/release/); releases are source archives plus CI-published crates.io and PyPI.
Expand All @@ -6,7 +10,7 @@ Publishing software has legal consequences. This guide complements the foundatio

## Overview

![Release process overview](assets/release-guide.png)
![Release process overview](/img/release-guide.png)

The release process consists of:

Expand All @@ -22,7 +26,7 @@ The release process consists of:

Deciding to release and selecting a Release Manager is the first step. This is a consensus-based decision of the community.

Anybody can propose a release (e.g. on the dev mailing list), giving a short rationale and nominating a committer as Release Manager (including themselves). Any objections should be resolved by consensus before starting.
Anybody can propose a release (e.g. on the dev [mailing list](https://fluss.apache.org/community/welcome/)), giving a short rationale and nominating a committer as Release Manager (including themselves). Any objections should be resolved by consensus before starting.

**Checklist to proceed**

Expand Down Expand Up @@ -360,7 +364,7 @@ svn commit -m "Remove RC after release fluss-rust ${RELEASE_VERSION}"
2. Choose tag `$RELEASE_TAG`.
3. Set the target to the release branch `release-${RELEASE_VERSION}` (i.e., the branch/commit used to create `$RELEASE_TAG`).
4. Click **Generate release notes**, then add: notable changes, breaking changes (if any) from component upgrade docs, **official download link** (source archive and verification), and install instructions for fluss-rust, fluss-python, fluss-cpp.
- **Download link:** `https://downloads.apache.org/incubator/fluss/fluss-rust-${RELEASE_VERSION}/` (or the project download page). In the release description, include checksums and GPG verification steps.
- **Download link:** `https://downloads.apache.org/incubator/fluss/fluss-rust-${RELEASE_VERSION}/` (or the project download page). In the release description, include checksums and GPG verification steps.
5. Click **Publish release**.

### 6. Update CHANGELOG.md on main
Expand Down
3 changes: 2 additions & 1 deletion website/docs/user-guide/cpp/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,9 @@ Complete API reference for the Fluss C++ client.

When using `table.NewRow()`, the `Set()` method auto-routes to the correct type based on the schema:

| Method | Description |
| Method | Description |
|----------------------------------------------------------|-----------------------------------|
| `Set(const std::string& name, std::nullptr_t)` | Set field to null by column name |
| `Set(const std::string& name, bool value)` | Set boolean by column name |
| `Set(const std::string& name, int32_t value)` | Set integer by column name |
| `Set(const std::string& name, int64_t value)` | Set big integer by column name |
Expand Down
11 changes: 6 additions & 5 deletions website/docs/user-guide/rust/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,12 @@ Complete API reference for the Fluss Rust client.

### Partition Operations

| Method | Description |
|--------------------------------------------------------------------------------------------------------------------------|---------------------|
| `async fn list_partition_infos(&self, table_path: &TablePath) -> Result<Vec<PartitionInfo>>` | List all partitions |
| `async fn create_partition(&self, table_path: &TablePath, spec: &PartitionSpec, ignore_if_exists: bool) -> Result<()>` | Create a partition |
| `async fn drop_partition(&self, table_path: &TablePath, spec: &PartitionSpec, ignore_if_not_exists: bool) -> Result<()>` | Drop a partition |
| Method | Description |
|--------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
| `async fn list_partition_infos(&self, table_path: &TablePath) -> Result<Vec<PartitionInfo>>` | List all partitions |
| `async fn list_partition_infos_with_spec(&self, table_path: &TablePath, spec: Option<&PartitionSpec>) -> Result<Vec<PartitionInfo>>` | List partitions matching a spec |
| `async fn create_partition(&self, table_path: &TablePath, spec: &PartitionSpec, ignore_if_exists: bool) -> Result<()>` | Create a partition |
| `async fn drop_partition(&self, table_path: &TablePath, spec: &PartitionSpec, ignore_if_not_exists: bool) -> Result<()>` | Drop a partition |

### Offset Operations

Expand Down
8 changes: 7 additions & 1 deletion website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,13 @@ const sidebars: SidebarsConfig = {
'developer-guide/contributing',
],
},
'release',
{
type: 'category',
label: 'Release',
items: [
{type: 'autogenerated', dirName: 'release'},
],
},
],
};

Expand Down
File renamed without changes
Loading