Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: Add more post release notes #983

Merged
merged 7 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added mkdocs/docs/assets/images/gen-release-notes.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 29 additions & 6 deletions mkdocs/docs/how-to-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
sungwy marked this conversation as resolved.
Show resolved Hide resolved

sungwy marked this conversation as resolved.
Show resolved Hide resolved
![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**.
sungwy marked this conversation as resolved.
Show resolved Hide resolved

Choose the approved release version as the tag and **Generate release notes**.
sungwy marked this conversation as resolved.
Show resolved Hide resolved

**Set as the latest release** and **Publish**.