Skip to content

docs: improve release docs #2374

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.

Sign up for GitHub

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

Merged
Fokko merged 4 commits into from
Aug 28, 2025
Merged

docs: improve release docs #2374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fd4a2e3
add copy button to code snippets
kevinjqliu Aug 22, 2025
bf1e060
fix a few commands
kevinjqliu Aug 22, 2025
9ddc0ac
Apache PyIceberg -> Apache Iceberg Python
kevinjqliu Aug 22, 2025
59865a2
just use "PyIceberg"
kevinjqliu Aug 27, 2025
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
2 changes: 1 addition & 1 deletion .asf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
# https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features

github:
description: "Apache PyIceberg"
description: "PyIceberg"
homepage: https://py.iceberg.apache.org/
labels:
- iceberg
Expand Down
6 changes: 3 additions & 3 deletions mkdocs/docs/how-to-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ export LAST_COMMIT_ID=$(git rev-list ${GIT_TAG} 2> /dev/null | head -n 1)

cat << EOF > release-announcement-email.txt
To: dev@iceberg.apache.org
Subject: [VOTE] Release Apache PyIceberg $VERSION_WITH_RC
Subject: [VOTE] PyIceberg $VERSION_WITH_RC
Hi Everyone,

I propose that we release the following RC as the official PyIceberg $VERSION release.
Expand Down Expand Up @@ -351,9 +351,9 @@ Send out an announcement on the dev mail list:

```text
To: dev@iceberg.apache.org
Subject: [ANNOUNCE] Apache PyIceberg release <VERSION>
Subject: [ANNOUNCE] PyIceberg <VERSION>

I'm pleased to announce the release of Apache PyIceberg <VERSION>!
I'm pleased to announce the release of PyIceberg <VERSION>!

Apache Iceberg is an open table format for huge analytic datasets. Iceberg
delivers high query performance for tables with tens of petabytes of data,
Expand Down
9 changes: 7 additions & 2 deletions mkdocs/docs/verify-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

# Verifying a release

Each Apache PyIceberg release is validated by the community by holding a vote. A community release manager will prepare a release candidate and call a vote on the Iceberg dev list. To validate the release candidate, community members will test it out in their downstream projects and environments.
Each PyIceberg release is validated by the community by holding a vote. A community release manager will prepare a release candidate and call a vote on the Iceberg dev list. To validate the release candidate, community members will test it out in their downstream projects and environments.

In addition to testing in downstream projects, community members also check the release’s signatures, checksums, and license documentation.

Expand Down Expand Up @@ -48,13 +48,18 @@ Set an environment variable to the version to verify and path to use

```sh
export PYICEBERG_VERSION=<version> # e.g. 0.6.1rc3
```

And a temp folder for the artifacts

```sh
export PYICEBERG_VERIFICATION_DIR=/tmp/pyiceberg/${PYICEBERG_VERSION}
```

Next, verify the `.asc` file.

```sh
svn checkout https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-${PYICEBERG_VERSION}/ ${PYICEBERG_VERIFICATION_DIR}
svn checkout https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-$PYICEBERG_VERSION/ ${PYICEBERG_VERIFICATION_DIR}
Copy link
Contributor Author

@kevinjqliu kevinjqliu Aug 22, 2025

Choose a reason for hiding this comment

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

previously ${PYICEBERG_VERSION} would expand to $\{PYICEBERG_VERSION\}/ in iterm and mess up the url

Copy link
Contributor

@Fokko Fokko Aug 25, 2025

Choose a reason for hiding this comment

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

Caught me several times!

Copy link
Contributor Author

@kevinjqliu kevinjqliu Aug 25, 2025

Choose a reason for hiding this comment

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

same, but no more!


cd ${PYICEBERG_VERIFICATION_DIR}

Expand Down
1 change: 1 addition & 0 deletions mkdocs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ theme:
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- content.code.copy # Enables the copy button
palette:
- scheme: default
toggle:
Expand Down