Fokko commented on code in PR #147: URL: https://github.com/apache/iceberg-rust/pull/147#discussion_r1442602143
########## website/src/release.md: ########## @@ -0,0 +1,383 @@ +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. +--> + +This document mainly introduces how the release manager releases a new version in accordance with the Apache requirements. + +## Introduction + +`Source Release` is the key point which Apache values, and is also necessary for an ASF release. + +Please remember that publishing software has legal consequences. + +This guide complements the foundation-wide policies and guides: + +- [Release Policy](https://www.apache.org/legal/release-policy.html) +- [Release Distribution Policy](https://infra.apache.org/release-distribution) +- [Release Creation Process](https://infra.apache.org/release-publishing.html) + +## Some Terminology of release + +In the context of our release, we use several terms to describe different stages of the release process. + +Here's an explanation of these terms: + +- `iceberg_version`: the version of Iceberg to be released, like `0.2.0`. +- `release_version`: the version of release candidate, like `0.2.0-rc.1`. +- `rc_version`: the minor version for voting round, like `rc.1`. + +## Preparation + +<div class="warning"> + +This section is the requirements for individuals who are new to the role of release manager. + +</div> + +Refer to [Setup GPG Key](reference/setup_gpg.md) to make sure the GPG key has been set up. + +## 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. + +Title: + +``` +Tracking issues of Iceberg Rust ${iceberg_version} Release +``` + +Content: + +```markdown +This issue is used to track tasks of the iceberg rust ${iceberg_version} release. + +## Tasks + +### Blockers + +> Blockers are the tasks that must be completed before the release. + +### Build Release + +#### GitHub Side + +- [ ] Bump version in project +- [ ] Update docs +- [ ] Generate dependencies list +- [ ] Push release candidate tag to GitHub + +#### ASF Side + +- [ ] Create an ASF Release +- [ ] Upload artifacts to the SVN dist repo + +### Voting + +- [ ] Start VOTE at iceberg community + +### Official Release + +- [ ] Push the release git tag +- [ ] Publish artifacts to SVN RELEASE branch +- [ ] Change Iceberg Rust Website download link +- [ ] Send the announcement + +For details of each step, please refer to: https://rust.iceberg.apache.org/release +``` + +## GitHub Side + +### Bump version in project + +Bump all components' version in the project to the new iceberg version. +Please note that this version is the exact version of the release, not the release candidate version. + +- rust core: bump version in `Cargo.toml` + +### Update docs + +- Update `CHANGELOG.md`, refer to [Generate Release Note](reference/generate_release_note.md) for more information. + +### Generate dependencies list + +Download and setup `cargo-deny`. You can refer to [cargo-deny](https://embarkstudios.github.io/cargo-deny/cli/index.html). + +Running `python3 ./scripts/dependencies.py generate` to update the dependencies list of every package. + +### Push release candidate tag + +After bump version PR gets merged, we can create a GitHub release for the release candidate: + +- Create a tag at `main` branch on the `Bump Version` / `Patch up version` commit: `git tag -s "v0.2.0-rc.1"`, please correctly check out the corresponding commit instead of directly tagging on the main branch. +- Push tags to GitHub: `git push --tags`. + +## ASF Side + +If any step in the ASF Release process fails and requires code changes, +we will abandon that version and prepare for the next one. +Our release page will only display ASF releases instead of GitHub Releases. + +### Create an ASF Release + +After GitHub Release has been created, we can start to create ASF Release. + +- Checkout to released tag. (e.g. `git checkout v0.2.0-rc.1`, tag is created in the previous step) +- Use the release script to create a new release: `ICEBERG_VERSION=<iceberg_version> ICEBERG_VERSION_RC=<rc_version> ./scripts/release.sh`(e.g. `ICEBERG_VERSION=0.2.0 ICEBERG_VERSION_RC=rc.1 ./scripts/release.sh`) + - This script will do the following things: + - Create a new branch named by `release-${release_version}` from the tag + - Generate the release candidate artifacts under `dist`, including: + - `apache-iceberg-rust-${release_version}-src.tar.gz` + - `apache-iceberg-rust-${release_version}-src.tar.gz.asc` + - `apache-iceberg-rust-${release_version}-src.tar.gz.sha512` + - Check the header of the source code. This step needs docker to run. +- Push the newly created branch to GitHub + +This script will create a new release under `dist`. + +For example: + +```shell +> tree dist +dist +├── apache-iceberg-rust-0.2.0-src.tar.gz +├── apache-iceberg-rust-0.2.0-src.tar.gz.asc +└── apache-iceberg-rust-0.2.0-src.tar.gz.sha512 +``` + +### Upload artifacts to the SVN dist repo + +SVN is required for this step. + +The svn repository of the dev branch is: <https://dist.apache.org/repos/dist/dev/iceberg/iceberg-rust> + +First, checkout Iceberg to local directory: + +```shell +# As this step will copy all the versions, it will take some time. If the network is broken, please use svn cleanup to delete the lock before re-execute it. +svn co https://dist.apache.org/repos/dist/dev/iceberg/iceberg-rust iceberg-dist-dev +``` + +Then, upload the artifacts: + +> The `${release_version}` here should be like `0.2.0-rc.1` + +```shell +cd iceberg-dist-dev +# create a directory named by version +mkdir ${release_version} +# copy source code and signature package to the versioned directory +cp ${repo_dir}/dist/* ${release_version}/ +# check svn status +svn status +# add to svn +svn add ${release_version} +# check svn status +svn status +# commit to SVN remote server +svn commit -m "Prepare for ${release_version}" +``` + +Visit <https://dist.apache.org/repos/dist/dev/iceberg/iceberg-rust/> to make sure the artifacts are uploaded correctly. + +### Rescue + +If you accidentally published wrong or unexpected artifacts, like wrong signature files, wrong sha256 files, +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. + +## Voting + +Iceberg Community Vote should send email to: <d...@iceberg.apache.org>: + +Title: + +``` +[VOTE] Release Apache Iceberg Rust ${release_version} - Round 1 +``` + +Content: + +``` +Hello, Apache Iceberg Rust Community, + +This is a call for a vote to release Apache Iceberg rust version ${iceberg_version}. + +The tag to be voted on is ${iceberg_version}. + +The release candidate: + +https://dist.apache.org/repos/dist/dev/iceberg/iceberg-rust/${release_version}/ + +Keys to verify the release candidate: + +https://downloads.apache.org/iceberg/KEYS + +Git tag for the release: + +https://github.com/apache/iceberg-rust/releases/tag/${release_version} + +Please download, verify, and test. + +The VOTE will be open for at least 72 hours and until the necessary +number of votes are reached. + +[ ] +1 approve +[ ] +0 no opinion +[ ] -1 disapprove with the reason + +To learn more about apache iceberg, please see https://rust.iceberg.apache.org/ + +Checklist for reference: + +[ ] Download links are valid. +[ ] Checksums and signatures. +[ ] LICENSE/NOTICE files exist +[ ] No unexpected binary files +[ ] All source files have ASF headers +[ ] Can compile from source + +More detailed checklist please refer to: +https://github.com/apache/iceberg-rust/tree/main/scripts + +To compile from source, please refer to: +https://github.com/apache/iceberg-rust/blob/main/CONTRIBUTING.md + +Here is a Python script in release to help you verify the release candidate: + +./scripts/verify.py + +Thanks + +${name} +``` + +Example: <https://lists.apache.org/thread/c211gqq2yl15jbxqk4rcnq1bdqltjm5l> + +After at least 3 `+1` binding vote (from Iceberg PMC member), claim the vote result: + +Title: + +``` +[RESULT][VOTE] Release Apache Iceberg Rust ${release_version} - Round 1 +``` + +Content: + +``` +Hello, Apache Iceberg Rust Community, + +The vote to release Apache Iceberg Rust ${release_version} has passed. + +The vote PASSED with 3 +1 binding and 1 +1 non-binding votes, no +0 or -1 votes: + +Binding votes: + +- xxx +- yyy +- zzz + +Non-Binding votes: + +- aaa + +Vote thread: ${vote_thread_url} + +Thanks + +${name} +``` + +Example: <https://lists.apache.org/thread/xk5myl10mztcfotn59oo59s4ckvojds6> + +## Official Release + +### Push the release git tag + +```shell +# Checkout the tags that passed VOTE +git checkout ${release_version} +# Tag with the iceberg version +git tag -s ${iceberg_version} +# Push tags to github to trigger releases +git push origin ${iceberg_version} +``` + +### Publish artifacts to SVN RELEASE branch + +```shell +svn mv https://dist.apache.org/repos/dist/dev/iceberg/iceberg-rust/${release_version} https://dist.apache.org/repos/dist/release/iceberg/iceberg-rust/${iceberg_version} -m "Release ${iceberg_version}" +``` + +### Change Iceberg Rust Website download link + +Update the download link in `website/src/download.md` to the new release version. + +### Create a GitHub 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. + +### Send the announcement + +Send the release announcement to `d...@iceberg.apache.org` and CC `annou...@apache.org`. + +Instead of adding breaking changes, let's include the new features as "notable changes" in the announcement. + +Title: + +``` +[ANNOUNCE] Release Apache Iceberg Rust ${iceberg_version} +``` + +Content: + +``` +Hi all, + +The Apache Iceberg rust community is pleased to announce +that Apache Iceberg rust ${iceberg_version} has been released! Review Comment: I'm a bit of a nitpicker on this one, but I noticed that we don't have a consistent way of capitalizing Apache, Iceberg and Rust. ```suggestion The Apache Iceberg Rust community is pleased to announce that Apache Iceberg Rust ${iceberg_version} has been released! ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
