This is an automated email from the ASF dual-hosted git repository.
sungwy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-python.git
The following commit(s) were added to refs/heads/main by this push:
new 38097080 DOCS: Add more post release notes (#983)
38097080 is described below
commit 3809708074480a0a5d3a02738a76aafe2b3e3eb5
Author: Sung Yun <[email protected]>
AuthorDate: Wed Jul 31 15:02:51 2024 -0400
DOCS: Add more post release notes (#983)
* add more release notes
* lint
* adopt feedback
* Thanks Fokko!
Co-authored-by: Fokko Driesprong <[email protected]>
* update instrutions for copying artifacts to release dist
* nits
---------
Co-authored-by: Sung Yun <[email protected]>
Co-authored-by: Fokko Driesprong <[email protected]>
---
mkdocs/docs/assets/images/gen-release-notes.jpg | Bin 0 -> 73250 bytes
mkdocs/docs/how-to-release.md | 35 ++++++++++++++++++++----
2 files changed, 29 insertions(+), 6 deletions(-)
diff --git a/mkdocs/docs/assets/images/gen-release-notes.jpg
b/mkdocs/docs/assets/images/gen-release-notes.jpg
new file mode 100644
index 00000000..a5842e4b
Binary files /dev/null and b/mkdocs/docs/assets/images/gen-release-notes.jpg
differ
diff --git a/mkdocs/docs/how-to-release.md b/mkdocs/docs/how-to-release.md
index 07e60895..ce38cbfc 100644
--- a/mkdocs/docs/how-to-release.md
+++ b/mkdocs/docs/how-to-release.md
@@ -198,16 +198,25 @@ Kind regards,
### Copy the artifacts to the release dist
```
-svn checkout https://dist.apache.org/repos/dist/dev/iceberg
/tmp/iceberg-dist-dev
-svn checkout https://dist.apache.org/repos/dist/release/iceberg/
/tmp/iceberg-dist-release
+export RC=rc2
+export VERSION=0.7.0${RC}
+export VERSION_WITHOUT_RC=${VERSION/rc?/}
-mkdir -p /tmp/iceberg-dist-release/pyiceberg-<VERSION>
-cp -r /tmp/iceberg-dist-dev/pyiceberg-<VERSION>rcN/*
/tmp/iceberg-dist-release/pyiceberg-<VERSION>
+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}";
-svn add /tmp/iceberg-dist-release/
-svn ci -m "PyIceberg <VERSION>" /tmp/iceberg-dist-release/
+svn mv ${SVN_DEV_DIR_VERSIONED} ${SVN_RELEASE_DIR_VERSIONED} -m "PyIceberg:
Add release ${VERSION_WITHOUT_RC}"
```
+<!-- prettier-ignore-start -->
+
+!!! note
+ Only a PMC member has the permission to upload an artifact to the SVN
release dist.
+
+<!-- prettier-ignore-end -->
+
+### Upload the accepted release to PyPi
+
The latest version can be pushed to PyPi. Check out the Apache SVN and make
sure to publish the right version with `twine`:
```bash
@@ -243,3 +252,17 @@ Make sure to create a PR to update the [GitHub issues
template](https://github.c
## Update the integration tests
Ensure to update the `PYICEBERG_VERSION` in the
[Dockerfile](https://github.com/apache/iceberg-python/blob/main/dev/Dockerfile).
+
+## Create a Github Release Note
+
+Create a [new Release
Note](https://github.com/apache/iceberg-python/releases/new) on the
iceberg-python Github repository.
+
+Input the tag in **Choose a tag** with the newly approved released version
(e.g. `0.7.0`) and set it to **Create new tag** on publish. Pick the target
commit version as the commit ID the release was approved on.
+For example:
+
+
+Then, select the previous release version as the **Previous tag** to use the
diff between the two versions in generating the release notes.
+
+**Generate release notes**.
+
+**Set as the latest release** and **Publish**.
