Skip to content

chore: Update release runbook #2674

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
CTTY merged 2 commits into from
Jun 23, 2026
Merged

chore: Update release runbook #2674

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ef5ecf
chore: Update release runbook
dannycjones Jun 19, 2026
3d5217f
Merge branch 'main' into update-release-runbook
dannycjones Jun 20, 2026
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
54 changes: 35 additions & 19 deletions website/src/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
~ under the License.
-->

This document explains how the release manager releases Apache Iceberg Rust in accordance with Apache requirements.
This document explains how the release process works for Apache Iceberg Rust in accordance with Apache requirements.

## Introduction

Expand All @@ -43,6 +43,13 @@ In this guide:

The RC tag includes `rc.<number>`. The ASF dev distribution directory uses `rc<number>`. The source archive name uses only the final version.

## Release Manager

The release manager is the person taking ownership of a particular Iceberg Rust release.

This is usually a committer for the Apache Iceberg project, however the role can be supported by non-committers in the early stages of coordinating a release.
Where this can be supported by a non-committer, this will be mentioned in the guide.

## Preparation

<div class="warning">
Expand All @@ -66,6 +73,8 @@ The local release helpers are under `dev/release/`. They log every step before i
## Start a tracking issue about the next release

Start a tracking issue on GitHub for the upcoming release to track all tasks that need to be completed.
You should own this tracking issue and coordinate with the community when to target a new release and what changes need to be included.
You do not need to be a committer to create and own the tracking issue.

Title:

Expand All @@ -88,8 +97,8 @@ This issue is used to track tasks of the iceberg rust ${iceberg_version} release

#### GitHub Side

- [ ] Bump version in project
- [ ] Update docs
- [ ] Draft GitHub release

@CTTY CTTY Jun 19, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Could you help me understand what is this?

@dannycjones dannycjones Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This was already in the instructions to generate the release notes but not properly documented. When creating it, you tell it the final tag name that it'll create and press generate to provide a set of release notes. These would be copied into CHANGELOG.md.

That being said, it sounds like not everyone had been using this for generating release notes. I'm happy to make it otherwise clearer and focus on the GitHub release only at the end if that makes sense (i.e. skip the draft).

- [ ] Bump version in project and update changelog
- [ ] Create and push release candidate tag

#### ASF Side
Expand All @@ -103,26 +112,38 @@ This issue is used to track tasks of the iceberg rust ${iceberg_version} release

### Official Release

- [ ] Push the release git tag
- [ ] Publish artifacts to SVN RELEASE branch
- [ ] Change Iceberg Rust Website download link
- [ ] Publish GitHub release, automatically pushing the Git tag
- [ ] Send the announcement

For details of each step, please refer to: https://rust.iceberg.apache.org/release
```

## GitHub Side

### Bump version in project
The following steps should be followed once the release is ready to begin.

### Draft GitHub release

- [Draft a new GitHub Release using the GitHub web UI](https://github.com/apache/iceberg-rust/releases/new).
- Enter the git tag of this release version, of the form `v0.y.z`. For example, `v0.9.0`.
The tag should not exist at this stage and GitHub will offer to create it when the release is published.
- Make sure the branch target is `main` for minor release (such as `0.9.0`), or the minor version branch for a patch release (such as `0.9.1`).
- Generate the release note by clicking the `Generate release notes` button.
- Save the draft.

### Update crate versions and changelog

Bump all components' version in the project to the new Iceberg Rust version.
This version is the final version, not the release candidate version.

- Rust core and Python binding: bump version in root `Cargo.toml` under `[workspace.package]`.

### Update docs
Use the content of the draft GitHub release to update `CHANGELOG.md`.
Since drafting a GitHub release requires `content: write` GitHub permissions, this step must be owned by a committer.

Update `CHANGELOG.md` by drafting a new release [note on GitHub Releases](https://github.com/apache/iceberg-rust/releases/new).
Open a pull request with both the changes to the crate versions and the associated changelog for the new versions.

### Create release candidate tag and artifacts

Expand Down Expand Up @@ -424,22 +445,17 @@ Useful options include:
- `--dev_dist_url https://dist.apache.org/repos/dist/dev/iceberg`: SVN directory URL containing RC artifact directories.
- `--release_dist_url https://dist.apache.org/repos/dist/release/iceberg`: SVN directory URL where final release artifact directories are published.

The release script does not push the final release tag. Review the output, then push the tag manually:
The release script does not push the final release tag.
Review the output and then move on to the next step to publish the GitHub release and tag.

```shell
git push origin "v${iceberg_version}"
```
### Publish the GitHub Release

Pushing the final release tag triggers the publish workflow for crates and pyiceberg-core.
A GitHub release should have been drafted earlier in the release process.
Open the release and publish it now.

### Create a GitHub Release
On publish, the Git tag will be created for the release.

- Click [here](https://github.com/apache/iceberg-rust/releases/new) to create a new release.
- Pick the git tag of this release version from the dropdown menu.
- Make sure the branch target is `main`.
- Generate the release note by clicking the `Generate release notes` button.
- Add the release note from every component's `upgrade.md` if there are breaking changes before the content generated by GitHub. Check them carefully.
- Publish the release.
The creation of the final release tag triggers the publish workflow for crates and pyiceberg-core.

### Send the announcement

Expand Down
Loading