add docs

Author: kevinjqliu

.github/workflows/python-release.yml

@@ -184,7 +184,7 @@ jobs:
       - name: Merge Artifacts
         uses: actions/upload-artifact/merge@v4
         with:
-          name: "svn-release-candidate-${{ needs.validate-inputs.outputs.VERSION }}-rc${{ needs.validate-inputs.outputs.RC }}"
+          name: "svn-release-candidate-${{ needs.validate-inputs.outputs.VERSION }}rc${{ needs.validate-inputs.outputs.RC }}"
           pattern: svn-release-candidate*
           delete-merged: true
 
@@ -263,6 +263,6 @@ jobs:
       - name: Merge Artifacts
         uses: actions/upload-artifact/merge@v4
         with:
-          name: "pypi-release-candidate-${{ needs.validate-inputs.outputs.VERSION }}-rc${{ needs.validate-inputs.outputs.RC }}"
+          name: "pypi-release-candidate-${{ needs.validate-inputs.outputs.VERSION }}rc${{ needs.validate-inputs.outputs.RC }}"
           pattern: pypi-release-candidate*
           delete-merged: true

mkdocs/docs/assets/images/ghactions-run-workflow-pypi-upload.png

@@ -109,45 +109,42 @@ Create a signed tag:
 Replace `VERSION` and `RC` with the appropriate values for the release.
 
 ```bash
-export RC=rc1
-export VERSION=0.7.0${RC}
-export VERSION_WITHOUT_RC=${VERSION/rc?/}
-export VERSION_BRANCH=${VERSION_WITHOUT_RC//./-}
-export GIT_TAG=pyiceberg-${VERSION}
+export VERSION=0.7.0
+export RC=1
 
-git tag -s ${GIT_TAG} -m "PyIceberg ${VERSION}"
+export VERSION_WITH_RC=${VERSION}rc${RC}
+export GIT_TAG=pyiceberg-${VERSION_WITH_RC}
+
+git tag -s ${GIT_TAG} -m "PyIceberg ${VERSION_WITH_RC}"
 git push [email protected]:apache/iceberg-python.git ${GIT_TAG}
 ```
 
-### Publish Release Candidate (RC)
+### Create Artifacts
 
-#### Upload to Apache Dev SVN
+The [`Python Build Release Candidate` Github Action](https://github.com/apache/iceberg-python/actions/workflows/python-release.yml) will run automatically upon tag push.
 
-##### Create Artifacts for SVN
+This action will generate artifacts that will include both source distribution (`sdist`) and binary distributions (`wheels` using [`cibuildwheel`](https://github.com/pypa/cibuildwheel)) for each architectures.
 
-Run the [`Python release` Github Action](https://github.com/apache/iceberg-python/actions/workflows/python-release.yml).
+This action will generate two final artifacts:
 
-* Tag: Use the newly created tag.
-* Version: Set the `version` to `main`, as the source cannot be modified.
+* `svn-release-candidate-${VERSION}rc${RC}` for SVN
+* `pypi-release-candidate-${VERSION}rc${RC}` for PyPi
 
-![Github Actions Run Workflow for SVN Upload](assets/images/ghactions-run-workflow-svn-upload.png)
-
-This action will generate:
+### Publish Release Candidate (RC)
 
-* Source distribution (`sdist`)
-* Binary distributions (`wheels`) for each architectures. These are created using [`cibuildwheel`](https://github.com/pypa/cibuildwheel)
+#### Upload to Apache Dev SVN
 
 ##### Download Artifacts, Sign, and Generate Checksums
 
-Download the ZIP file containing the artifacts from the GitHub Actions run and unzip it.
+Download the SVN artifact from the GitHub Action and unzip it.
 
-Navigate to the release directory. Sign the files and generate checksums:
+Navigate to the artifact directory. Generate signature and checksum files:
 
 * `.asc` files: GPG-signed versions of each artifact to ensure authenticity.
 * `.sha512` files: SHA-512 checksums for verifying file integrity.
 
 ```bash
-cd release-main/
+cd svn-release-candidate-${VERSION}rc${RC}
 
 for name in $(ls pyiceberg-*.whl pyiceberg-*.tar.gz)
 do
@@ -161,14 +158,14 @@ done
 Now, upload the files from the same directory:
 
 ```bash
-export SVN_TMP_DIR=/tmp/iceberg-${VERSION_BRANCH}/
+export SVN_TMP_DIR=/tmp/iceberg-${VERSION}/
 svn checkout https://dist.apache.org/repos/dist/dev/iceberg $SVN_TMP_DIR
 
-export SVN_TMP_DIR_VERSIONED=${SVN_TMP_DIR}pyiceberg-$VERSION/
+export SVN_TMP_DIR_VERSIONED=${SVN_TMP_DIR}pyiceberg-$VERSION_WITH_RC/
 mkdir -p $SVN_TMP_DIR_VERSIONED
 cp * $SVN_TMP_DIR_VERSIONED
 svn add $SVN_TMP_DIR_VERSIONED
-svn ci -m "PyIceberg ${VERSION}" ${SVN_TMP_DIR_VERSIONED}
+svn ci -m "PyIceberg ${VERSION_WITH_RC}" ${SVN_TMP_DIR_VERSIONED}
 ```
 
 Verify the artifact is uploaded to [https://dist.apache.org/repos/dist/dev/iceberg](https://dist.apache.org/repos/dist/dev/iceberg/).
@@ -183,22 +180,13 @@ svn delete https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-<OLD_RC_VERS
 
 #### Upload to PyPi
 
-##### Create Artifacts for PyPi
-
-Run the [`Python release` Github Action](https://github.com/apache/iceberg-python/actions/workflows/python-release.yml).
-
-* Tag: Use the newly created tag.
-* Version: Set the `version` to release candidate, e.g. `0.7.0rc1`.
-
-![Github Actions Run Workflow for PyPi Upload](assets/images/ghactions-run-workflow-pypi-upload.png)
-
 ##### Download Artifacts
 
-Download the zip file from the Github Action run and unzip locally.
+Download the PyPi artifact from the GitHub Action and unzip it.
 
 ##### Upload Artifacts to PyPi
 
-Upload release candidate to PyPi. This **won't** bump the version for everyone that hasn't pinned their version, since it is set to an RC [pre-release and those are ignored](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#pre-release-versioning).
+Update the artifact directory to PyPi using `twine`. This **won't** bump the version for everyone that hasn't pinned their version, since it is set to an RC [pre-release and those are ignored](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#pre-release-versioning).
 
 <!-- prettier-ignore-start -->
 
@@ -208,7 +196,7 @@ Upload release candidate to PyPi. This **won't** bump the version for everyone t
 <!-- prettier-ignore-end -->
 
 ```bash
-twine upload release-${VERSION}/*
+twine upload pypi-release-candidate-${VERSION}rc${RC}/*
 ```
 
 Verify the artifact is uploaded to [PyPi](https://pypi.org/project/pyiceberg/#history).
@@ -226,10 +214,10 @@ export LAST_COMMIT_ID=$(git rev-list ${GIT_TAG} 2> /dev/null | head -n 1)
 
 cat << EOF > release-announcement-email.txt
 To: [email protected]
-Subject: [VOTE] Release Apache PyIceberg $VERSION
+Subject: [VOTE] Release Apache PyIceberg $VERSION_WITH_RC
 Hi Everyone,
 
-I propose that we release the following RC as the official PyIceberg $VERSION_WITHOUT_RC release.
+I propose that we release the following RC as the official PyIceberg $VERSION release.
 
 A summary of the high level features:
 
@@ -243,17 +231,17 @@ The commit ID is $LAST_COMMIT_ID
 
 The release tarball, signature, and checksums are here:
 
-* https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-$VERSION/
+* https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-$VERSION_WITH_RC/
 
 You can find the KEYS file here:
 
 * https://downloads.apache.org/iceberg/KEYS
 
 Convenience binary artifacts are staged on pypi:
 
-https://pypi.org/project/pyiceberg/$VERSION/
+https://pypi.org/project/pyiceberg/$VERSION_WITH_RC/
 
-And can be installed using: pip3 install pyiceberg==$VERSION
+And can be installed using: pip3 install pyiceberg==$VERSION_WITH_RC
 
 Instructions for verifying a release can be found here:
 
@@ -262,7 +250,7 @@ Instructions for verifying a release can be found here:
 Please download, verify, and test.
 
 Please vote in the next 72 hours.
-[ ] +1 Release this as PyIceberg $VERSION_WITHOUT_RC
+[ ] +1 Release this as PyIceberg $VERSION
 [ ] +0
 [ ] -1 Do not release this because...
 EOF
@@ -302,10 +290,10 @@ Kind regards,
 <!-- prettier-ignore-end -->
 
 ```bash
-export SVN_DEV_DIR_VERSIONED="https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-${VERSION}"
-export SVN_RELEASE_DIR_VERSIONED="https://dist.apache.org/repos/dist/release/iceberg/pyiceberg-${VERSION_WITHOUT_RC}"
+export SVN_DEV_DIR_VERSIONED="https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-${VERSION_WITH_RC}"
+export SVN_RELEASE_DIR_VERSIONED="https://dist.apache.org/repos/dist/release/iceberg/pyiceberg-${VERSION}"
 
-svn mv ${SVN_DEV_DIR_VERSIONED} ${SVN_RELEASE_DIR_VERSIONED} -m "PyIceberg: Add release ${VERSION_WITHOUT_RC}"
+svn mv ${SVN_DEV_DIR_VERSIONED} ${SVN_RELEASE_DIR_VERSIONED} -m "PyIceberg: Add release ${VERSION}"
 ```
 
 Verify the artifact is uploaded to [https://dist.apache.org/repos/dist/release/iceberg](https://dist.apache.org/repos/dist/release/iceberg/).
@@ -331,7 +319,7 @@ The latest version can be pushed to PyPi. Check out the Apache SVN and make sure
 
 ```bash
 svn checkout https://dist.apache.org/repos/dist/release/iceberg /tmp/iceberg-dist-release/
-cd /tmp/iceberg-dist-release/pyiceberg-${VERSION_WITHOUT_RC}
+cd /tmp/iceberg-dist-release/pyiceberg-${VERSION}
 twine upload pyiceberg-*.whl pyiceberg-*.tar.gz
 ```