doc: introduce how to verify a release document #282
Conversation
There was a problem hiding this comment.
Pull request overview
Adds documentation and updates release tooling/docs to help the community verify Fluss client release candidates, aligning artifact naming with ASF Incubator requirements.
Changes:
- Update release artifact naming to include
-incubatinginscripts/release.shand release docs. - Add a new “How to Verify a Release Candidate” guide under
docs/. - Add/adjust component READMEs and link the new verification guide from the release process doc.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/release.sh | Renames the release artifact prefix to include -incubating and updates header comments accordingly. |
| docs/verifying-a-release-candidate.md | New guide documenting signature/checksum/build/license/test verification steps for RC voting. |
| docs/creating-a-release.md | Updates artifact names, staging commands, and links to the new verification guide. |
| crates/fluss/README.md | Adds a Rust client README (currently includes visible TODO notes). |
| bindings/python/README.md | Adds TODOs / notes around restructuring and future verification guidance. |
| bindings/cpp/README.md | Adds a C++ bindings README with build instructions and TODOs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@fresh-borzoni @leekeiabstraction Could you please help review? |
fresh-borzoni
left a comment
fresh-borzoni
left a comment
There was a problem hiding this comment.
@luoyuxia TY for the PR.
LGTM, left minor comments.
|
|
||
| ## TODO | ||
|
|
||
| - [] How to introduce fluss-cpp in your own project, https://github.com/apache/opendal/blob/main/bindings/cpp/README.md is a good reference |
There was a problem hiding this comment.
Let's remove it in next following pr :)
|
@fresh-borzoni Thank you for your review. Comments addressed. PTAL |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
2 participants
Purpose
Linked issue: close #269
Brief change log
Tests
API and Format
Documentation