Skip to content

Commit 3809708

Browse files
sungwyFokko
andauthored
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]>
1 parent 2acba74 commit 3809708

File tree

2 files changed

+29
-6
lines changed

2 files changed

+29
-6
lines changed
71.5 KB
Loading

mkdocs/docs/how-to-release.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -198,16 +198,25 @@ Kind regards,
198198
### Copy the artifacts to the release dist
199199

200200
```
201-
svn checkout https://dist.apache.org/repos/dist/dev/iceberg /tmp/iceberg-dist-dev
202-
svn checkout https://dist.apache.org/repos/dist/release/iceberg/ /tmp/iceberg-dist-release
201+
export RC=rc2
202+
export VERSION=0.7.0${RC}
203+
export VERSION_WITHOUT_RC=${VERSION/rc?/}
203204
204-
mkdir -p /tmp/iceberg-dist-release/pyiceberg-<VERSION>
205-
cp -r /tmp/iceberg-dist-dev/pyiceberg-<VERSION>rcN/* /tmp/iceberg-dist-release/pyiceberg-<VERSION>
205+
export SVN_DEV_DIR_VERSIONED="https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-${VERSION}"
206+
export SVN_RELEASE_DIR_VERSIONED="https://dist.apache.org/repos/dist/release/iceberg/pyiceberg-${VERSION_WITHOUT_RC}"
206207
207-
svn add /tmp/iceberg-dist-release/
208-
svn ci -m "PyIceberg <VERSION>" /tmp/iceberg-dist-release/
208+
svn mv ${SVN_DEV_DIR_VERSIONED} ${SVN_RELEASE_DIR_VERSIONED} -m "PyIceberg: Add release ${VERSION_WITHOUT_RC}"
209209
```
210210

211+
<!-- prettier-ignore-start -->
212+
213+
!!! note
214+
Only a PMC member has the permission to upload an artifact to the SVN release dist.
215+
216+
<!-- prettier-ignore-end -->
217+
218+
### Upload the accepted release to PyPi
219+
211220
The latest version can be pushed to PyPi. Check out the Apache SVN and make sure to publish the right version with `twine`:
212221

213222
```bash
@@ -243,3 +252,17 @@ Make sure to create a PR to update the [GitHub issues template](https://github.c
243252
## Update the integration tests
244253

245254
Ensure to update the `PYICEBERG_VERSION` in the [Dockerfile](https://github.com/apache/iceberg-python/blob/main/dev/Dockerfile).
255+
256+
## Create a Github Release Note
257+
258+
Create a [new Release Note](https://github.com/apache/iceberg-python/releases/new) on the iceberg-python Github repository.
259+
260+
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.
261+
For example:
262+
![Generate Release Notes](assets/images/gen-release-notes.jpg)
263+
264+
Then, select the previous release version as the **Previous tag** to use the diff between the two versions in generating the release notes.
265+
266+
**Generate release notes**.
267+
268+
**Set as the latest release** and **Publish**.

0 commit comments

Comments
 (0)