Skip to content

Add how to verify release doc #1426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

liurenjie1024
Copy link
Contributor

Which issue does this PR close?

What changes are included in this PR?

Add doc about how to verify release

Are these changes tested?

No.

@liurenjie1024 liurenjie1024 requested review from sdd, Xuanwo and Fokko and removed request for sdd June 9, 2025 10:39
```bash
curl https://downloads.apache.org/iceberg/KEYS -o KEYS
gpg --import KEYS
```
Copy link
Contributor

Choose a reason for hiding this comment

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

We can also include a section to download the release candidate and include the svn co command

Copy link
Contributor Author

@liurenjie1024 liurenjie1024 Jun 10, 2025

Choose a reason for hiding this comment

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

The link to artifacts will usually be included in the email voting for release, also user should not try to use svn co to download them. They should just use direct link. So I don't think we need to add them in the doc.

Copy link
Contributor

@geruh geruh Jun 11, 2025

Choose a reason for hiding this comment

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

ohh interesting, usually I follow the pyiceberg release docs since their documentation used to be the easiest to follow, but I just noticed that iceberg docs don't have this either

@liurenjie1024
Copy link
Contributor Author

Kindly ping @Fokko @Xuanwo @sdd @kevinjqliu to take a look

Copy link
Contributor

@kevinjqliu kevinjqliu left a comment

Choose a reason for hiding this comment

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

LGTM, this follows pyiceberg's "verify a release" doc

Added a few nit comments

Copy link
Contributor

Choose a reason for hiding this comment

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

nit: is this related to the PR?

@@ -202,6 +202,35 @@ please cancel the release for the current `release_version`,
_increase th RC counting_ and re-initiate a release with the new `release_version`.
And remember to delete the wrong artifacts from the SVN dist repo.

## How to verify a release
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: move this after the "Voting" section below, which sends out the email to vote for RC

@@ -202,6 +202,35 @@ please cancel the release for the current `release_version`,
_increase th RC counting_ and re-initiate a release with the new `release_version`.
And remember to delete the wrong artifacts from the SVN dist repo.

## How to verify a release
Copy link
Contributor

Choose a reason for hiding this comment

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

lets add a link to this new section to the RC vote email too. the current instruction in the email is outdated

Here is a Python script in release to help you verify the release candidate:
./scripts/verify.py

maybe we can remove scripts/verify.py too

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.

doc: Add how to verify a release section.
3 participants