Skip to content

add document for how to release and how to verify a release#235

Merged
JingsongLi merged 1 commit intoapache:mainfrom
luoyuxia:add-how-to-release
Apr 11, 2026
Merged

add document for how to release and how to verify a release#235
JingsongLi merged 1 commit intoapache:mainfrom
luoyuxia:add-how-to-release

Conversation

@luoyuxia
Copy link
Copy Markdown
Contributor

@luoyuxia luoyuxia commented Apr 11, 2026

Purpose

Linked issue: close #213

Add release documentation and supporting scripts for Apache Paimon Rust, covering how to create a release and how to verify a release candidate.

Brief change log

  • Add docs/src/release/creating-a-release.md: step-by-step guide for creating a release, including GPG setup, dependency list generation, release branch management, source tarball creation, SVN staging, voting process, and release promotion.
  • Add docs/src/release/verifying-a-release-candidate.md: guide for verifying an RC, including signature/checksum verification, build verification, LICENSE/NOTICE checks, and per-component testing (Rust, Python, Go).
  • Add scripts/release.sh: automates source tarball creation, GPG signing, and checksum generation.
  • Add scripts/bump-version.sh: bumps workspace version in root Cargo.toml (scoped to [workspace.package] only).
  • Add scripts/dependencies.py and scripts/constants.py: generates DEPENDENCIES.rust.tsv files for ASF license compliance.
  • Add bindings/go/DEPENDENCIES.md and TSV files for Go binding dependency tracking.
  • Update NOTICE and bindings/python/NOTICE copyright year to 2024-2026.
  • Update docs/mkdocs.yml to include the new release documentation pages.
  • Update Cargo.toml workspace version from 0.0.0 to 0.1.0.
  • Update .licenserc.yaml to exclude DEPENDENCIES.*.tsv from license header checks.

Tests

Documentation and script changes only. No code logic changes to test.
The whole workflow has been verified by fluss-rust

API and Format

No.

Documentation

Yes. This PR adds the release guide and verification guide to the project website under the "Releases" section.

@luoyuxia luoyuxia force-pushed the add-how-to-release branch from 309f6ec to 6ed8ea2 Compare April 11, 2026 03:10
@luoyuxia luoyuxia force-pushed the add-how-to-release branch from 6ed8ea2 to a4028aa Compare April 11, 2026 03:22
@luoyuxia luoyuxia marked this pull request as ready for review April 11, 2026 03:22
Copy link
Copy Markdown
Contributor

@JingsongLi JingsongLi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 Thanks @luoyuxia !

@JingsongLi JingsongLi merged commit a3d535d into apache:main Apr 11, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Introduce how to release and how to verify release doc

2 participants