kevinjqliu commented on code in PR #983:
URL: https://github.com/apache/iceberg-python/pull/983#discussion_r1698846962


##########
mkdocs/docs/how-to-release.md:
##########
@@ -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
+
+Input the tag as the newly approved release version (e.g. `0.7.0`) and set it 
to create the tag on publish. Pick the target commit version as the commit ID 
the release was approved on.

Review Comment:
   nit: something like so specify where the input is
   ```
   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.
   ```



##########
mkdocs/docs/how-to-release.md:
##########
@@ -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
+
+Input the tag as the newly approved release version (e.g. `0.7.0`) and set it 
to create the tag on publish. Pick the target commit version as the commit ID 
the release was approved on.
+
+![Generate Release Notes](assets/images/gen-release-notes.jpg)
+
+Then, select the previous release version as the **Previous tag** to use the 
diff between the two versions in generating the release notes.
+
+Create a new [Release 
Note](https://github.com/apache/iceberg-python/releases/new) on the 
iceberg-python Github repository by clicking on **Draft a New Release**.
+
+Choose the approved release version as the tag and **Generate release notes**.

Review Comment:
   I think the `Choose the approved release version as the tag` can be omitted 
here
   
   



##########
mkdocs/docs/how-to-release.md:
##########
@@ -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
+
+Input the tag as the newly approved release version (e.g. `0.7.0`) and set it 
to create the tag on publish. Pick the target commit version as the commit ID 
the release was approved on.
+
+![Generate Release Notes](assets/images/gen-release-notes.jpg)
+
+Then, select the previous release version as the **Previous tag** to use the 
diff between the two versions in generating the release notes.
+
+Create a new [Release 
Note](https://github.com/apache/iceberg-python/releases/new) on the 
iceberg-python Github repository by clicking on **Draft a New Release**.

Review Comment:
   nit: do you think this can be moved to the first line? 
   
   Maybe something like:
   Create a [new Release 
Note](https://github.com/apache/iceberg-python/releases/new) on the 
iceberg-python Github repository
   
   The link goes directly to the new release page
   
   



##########
mkdocs/docs/how-to-release.md:
##########
@@ -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
+
+Input the tag as the newly approved release version (e.g. `0.7.0`) and set it 
to create the tag on publish. Pick the target commit version as the commit ID 
the release was approved on.
+

Review Comment:
   For example: 



-- 
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

Reply via email to