Skip to content

chore: Update release runbook to use explicit Git tag pushing #2707

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

Draft
dannycjones wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −7
Draft

chore: Update release runbook to use explicit Git tag pushing #2707

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 11 additions & 7 deletions website/src/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,10 @@ This issue is used to track tasks of the iceberg rust ${iceberg_version} release

### Official Release

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

For details of each step, please refer to: https://rust.iceberg.apache.org/release
Expand All @@ -128,7 +129,8 @@ The following steps should be followed once the release is ready to begin.

- [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.
The tag should not exist at this stage.
While it may suggest it can automatically create the tag on publish, we will push manually as we rely on signed tags.
- 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.
Expand Down Expand Up @@ -446,17 +448,19 @@ Useful options include:
- `--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 and then move on to the next step to publish the GitHub release and tag.
Review the output, then push the tag manually:

```shell
git push origin "v${iceberg_version}"
```

Pushing the final release tag triggers the publish workflow for crates and pyiceberg-core.

### Publish the GitHub Release

A GitHub release should have been drafted earlier in the release process.
Open the release and publish it now.

On publish, the Git tag will be created for the release.

The creation of the final release tag triggers the publish workflow for crates and pyiceberg-core.

### Send the announcement

Send the release announcement to `dev@iceberg.apache.org` and CC `announce@apache.org`.
Expand Down
Loading