build: add how to release doc by luoyuxia · Pull Request #268 · apache/fluss-rust

luoyuxia · 2026-02-07T11:00:37Z

Purpose

Add release documentation and tooling so the project can perform ASF-compliant releases: step-by-step guides, dependency list generation, version bump and release scripts, and GitHub release note configuration.

Linked issue

Closes #210

Brief change log

Docs: HOW_TO_RELEASE.md, docs/creating-a-fluss-rust-release.md (and docs/creating-a-release.md) with full flow: decide → prepare → build RC → vote → finalize → promote. Prepare includes: env vars, optional DISCUSS, generate dependencies list (cargo-deny + script), create release branch, bump version on main, optional PRs for blog/download page. Build RC: checkout + tag + push, create artifacts (just release), stage to SVN dev, with directly executable cp ../dist/.... Finalize: SVN dev→release, verify crates.io/PyPI, GitHub Release with official download link and verification steps, CHANGELOG. Promote: merge website PRs, announce (template with download + KEYS links).
Scripts: scripts/release.sh (existing), scripts/bump-version.sh (bump root Cargo.toml), scripts/dependencies.py + scripts/constants.py (generate DEPENDENCIES.rust.tsv per package via cargo-deny; recursive list_packages()). just release [version], just bump-version <from> <to>.
Release notes: .github/release.yml for categorized auto-generated release notes (Added, Fixed, Docs, etc.). docs/generate-release-note.md simplified to point at it.
Misc: Commit message for dependency list includes ${RELEASE_VERSION}. Docs use git add **/DEPENDENCIES*.tsv for all modules. License headers added to docs/creating-a-release.md and docs/generate-release-note.md.

Tests

API and Format

Documentation

luoyuxia · 2026-02-07T11:04:25Z

@fresh-borzoni @leekeiabstraction @zhaohaidao Could you please help review this?

Copilot

Pull request overview

This PR adds end-to-end release documentation and automation for publishing Fluss client artifacts (Rust crate + Python wheels/sdist) and generating ASF-compliant source release artifacts.

Changes:

Added comprehensive release documentation (release process + generating GitHub release notes).
Added release/helper scripts (release.sh, bump-version.sh, dependency list generator) and just tasks.
Added GitHub Actions workflows for Rust (crates.io) and Python (PyPI/TestPyPI) releases, plus GitHub release-notes configuration.

Reviewed changes

Copilot reviewed 17 out of 18 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
`scripts/release.sh`	Creates source tarball + checksum + GPG signature under `dist/`.
`scripts/bump-version.sh`	Automates bumping the root workspace version.
`scripts/constants.py`	Discovers Cargo packages in the repo for dependency reporting.
`scripts/dependencies.py`	Runs `cargo deny` checks and generates `DEPENDENCIES.rust.tsv` files.
`justfile`	Adds `just release` and `just bump-version` shortcuts.
`docs/creating-a-release.md`	Full release manager guide (RCs, voting, staging to SVN, finalization).
`docs/generate-release-note.md`	Instructions for GitHub “Generate release notes”.
`README.md`	Adds “Documentation” section linking to dev/release docs.
`Cargo.toml`	Updates workspace metadata and renames the workspace dependency key to `fluss-rs`.
`crates/fluss/Cargo.toml`	Renames package to `fluss-rs` and adds workspace metadata fields.
`crates/examples/Cargo.toml`	Switches examples to depend on `fluss-rs`.
`bindings/python/pyproject.toml`	Renames PyPI project to `pyfluss` and updates metadata/URLs.
`bindings/python/Cargo.toml`	Switches Python binding to depend on `fluss-rs` via workspace.
`bindings/cpp/Cargo.toml`	Switches C++ binding to depend on `fluss-rs` via workspace.
`.github/workflows/release_rust.yml`	Adds crates.io publish workflow on tag pushes.
`.github/workflows/release_python.yml`	Adds PyPI/TestPyPI publish workflow on tag pushes.
`.github/release.yml`	Configures GitHub auto-generated release notes categories.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Cargo.toml

crates/examples/Cargo.toml

crates/fluss/Cargo.toml

README.md

scripts/bump-version.sh

docs/creating-a-release.md

scripts/release.sh

scripts/dependencies.py

.github/workflows/release_rust.yml

scripts/dependencies.py

luoyuxia · 2026-02-07T11:07:41Z

crates/fluss/Cargo.toml

 license.workspace = true
 rust-version = { workspace = true }
 version = { workspace = true }
+name = "fluss-rs"


it's pitty that fluss has been occupied in crate. So, we have to use another name.

Copilot

Pull request overview

Copilot reviewed 17 out of 18 changed files in this pull request and generated 10 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

scripts/dependencies.py

docs/generate-release-note.md

scripts/release.sh

.github/workflows/release_python.yml

docs/creating-a-release.md

.github/workflows/release_rust.yml

.github/workflows/release_python.yml

Copilot

Pull request overview

Copilot reviewed 17 out of 18 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

scripts/constants.py

justfile

docs/creating-a-release.md

.github/workflows/release_rust.yml

Copilot

Pull request overview

Copilot reviewed 17 out of 18 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.github/workflows/release_python.yml

scripts/constants.py

scripts/bump-version.sh

docs/creating-a-release.md

fresh-borzoni

@luoyuxia Thank you for the PR.
LGTM overall.
Some comments related python build and also we may wish to consider safety check to avoid scenarios like:

  1. You tag v0.2.0 and push it
  2. But you forgot to run bump-version.sh — Cargo.toml version = "0.1.0"
  3. CI triggers on the v0.2.0 tag, runs cargo publish, and publishes version 0.1.0 to crates.io

.github/workflows/release_python.yml

fresh-borzoni · 2026-02-07T12:58:23Z

.github/workflows/release_rust.yml

+on:
+  push:
+    tags:
+      - "*"


nit: Do we wish to release on any tag pushes?

let's limit to v*

luoyuxia · 2026-02-07T14:08:44Z

@fresh-borzoni Thanks for your review. Comments addressed.

fresh-borzoni

@luoyuxia TY! LGTM

Copilot

Pull request overview

Copilot reviewed 18 out of 19 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.github/workflows/release_python.yml

scripts/bump-version.sh

docs/creating-a-release.md

.github/workflows/release_rust.yml

luoyuxia · 2026-02-08T01:01:33Z

will merge it and then to improve if has any

luoyuxia added 2 commits February 7, 2026 11:38

chore: create release guide

77bdd64

update

251877c

luoyuxia requested a review from Copilot February 7, 2026 11:00

Copilot started reviewing on behalf of luoyuxia February 7, 2026 11:01 View session

luoyuxia force-pushed the create-release-guide branch from f1df2d2 to e37280f Compare February 7, 2026 11:03

Copilot AI reviewed Feb 7, 2026

View reviewed changes

luoyuxia commented Feb 7, 2026

View reviewed changes

build: add how to release doc

6b925b4

luoyuxia force-pushed the create-release-guide branch from e37280f to a568525 Compare February 7, 2026 11:48

luoyuxia requested a review from Copilot February 7, 2026 11:48

Copilot started reviewing on behalf of luoyuxia February 7, 2026 11:49 View session

Copilot AI reviewed Feb 7, 2026

View reviewed changes

address comments

71ce34d

luoyuxia force-pushed the create-release-guide branch from a568525 to 71ce34d Compare February 7, 2026 12:05

luoyuxia requested a review from Copilot February 7, 2026 12:07

Copilot started reviewing on behalf of luoyuxia February 7, 2026 12:07 View session

Copilot AI reviewed Feb 7, 2026

View reviewed changes

address comments1

1e215b4

luoyuxia requested a review from Copilot February 7, 2026 12:19

Copilot started reviewing on behalf of luoyuxia February 7, 2026 12:20 View session

Copilot AI reviewed Feb 7, 2026

View reviewed changes

.github/workflows/release_python.yml Show resolved Hide resolved

scripts/constants.py Show resolved Hide resolved

scripts/bump-version.sh Show resolved Hide resolved

docs/creating-a-release.md Outdated Show resolved Hide resolved

fresh-borzoni reviewed Feb 7, 2026

View reviewed changes

AndreaBozzo approved these changes Feb 7, 2026

View reviewed changes

luoyuxia force-pushed the create-release-guide branch from fb2ea62 to 7065e13 Compare February 7, 2026 14:07

address comments

393976c

luoyuxia force-pushed the create-release-guide branch from 7065e13 to 393976c Compare February 7, 2026 14:07

luoyuxia requested review from Copilot and fresh-borzoni February 7, 2026 14:08

Copilot started reviewing on behalf of luoyuxia February 7, 2026 14:08 View session

fresh-borzoni approved these changes Feb 7, 2026

View reviewed changes

Copilot AI reviewed Feb 7, 2026

View reviewed changes

.github/workflows/release_python.yml Show resolved Hide resolved

scripts/bump-version.sh Show resolved Hide resolved

docs/creating-a-release.md Show resolved Hide resolved

.github/workflows/release_rust.yml Show resolved Hide resolved

luoyuxia merged commit 499fa8c into apache:main Feb 8, 2026
19 checks passed

Conversation

luoyuxia commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Linked issue

Brief change log

Tests

API and Format

Documentation

Uh oh!

luoyuxia commented Feb 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

luoyuxia Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fresh-borzoni left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fresh-borzoni Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

luoyuxia Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

luoyuxia commented Feb 7, 2026

Uh oh!

fresh-borzoni left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

luoyuxia commented Feb 7, 2026 •

edited

Loading

fresh-borzoni left a comment •

edited

Loading