Improve documentation for "how to release" #1359
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Lets run this for 0.8.1 patch release |
Fokko
reviewed
Nov 21, 2024
|
|
||
| ```bash | ||
| cd release-main/ | ||
|
|
||
| for name in $(ls pyiceberg-*.whl pyiceberg-*.tar.gz) | ||
| do | ||
| gpg --yes --armor --local-user fokko@apache.org --output "${name}.asc" --detach-sig "${name}" |
Fokko
reviewed
Nov 21, 2024
| @@ -128,21 +144,51 @@ svn add $SVN_TMP_DIR_VERSIONED | |||
| svn ci -m "PyIceberg ${VERSION}" ${SVN_TMP_DIR_VERSIONED} | |||
| ``` | |||
|
|
|||
| ### Upload to PyPi | |||
| Verify the artifact is uploaded to [https://dist.apache.org/repos/dist/dev/iceberg](https://dist.apache.org/repos/dist/dev/iceberg/). | |||
There was a problem hiding this comment.
Can we add a section for deleting old RCs?
There was a problem hiding this comment.
svn delete https://dist.apache.org/repos/dist/dev/iceberg/pyiceberg-<OLD_RC_VERSION> -m "Remove old RC artifacts"
I think this is the right command, will test during 0.8.1 release
Fokko
reviewed
Nov 21, 2024
| 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 mv ${SVN_DEV_DIR_VERSIONED} ${SVN_RELEASE_DIR_VERSIONED} -m "PyIceberg: Add release ${VERSION_WITHOUT_RC}" | ||
| ``` | ||
|
|
||
| Verify the artifact is uploaded to [https://dist.apache.org/repos/dist/release/iceberg](https://dist.apache.org/repos/dist/release/iceberg/). |
There was a problem hiding this comment.
Can we add a step here to only host the lastest release on the dist/release/. I recently cleaned it up, but it would be good to make this part of the release itself :)
kevinjqliu
commented
Nov 22, 2024
Fokko
approved these changes
Nov 25, 2024
|
Thanks @kevinjqliu for cleaning this up 👍 |
kevinjqliu
added a commit
to kevinjqliu/iceberg-python
that referenced
this pull request
Nov 25, 2024
* initial update * edits * add gpg instructions * verify artifacts * add twine not * grammar * edits * remove old artifacts * update doc workflow action * and name * add docs on patch vs major/minor release
Fokko
reviewed
Nov 25, 2024
| git checkout pyiceberg-0.8.x | ||
|
|
||
| # Create a new branch for the upcoming patch release | ||
| git checkout -b pyiceberg-0.8.1 |
There was a problem hiding this comment.
What's the added value of having this branch? Once the release is out, there will be a tag, and I don't think there is any value in keeping the branch unless we want to go for a 0.8.1.1 release
kevinjqliu
added a commit
that referenced
this pull request
Nov 27, 2024
* use the non-deprecated func (#1326) * 0.8.0 post release steps (#1334) * add * fix mkdoc * Drop upper bounds for fsspec and it's implementations (#1341) * Drop upper bounds for fsspec and it's implementations * Run poetry lock * Ignore tables without `table_type` from Glue and Hive * Ignore tables without table_type parameters while loading all iceberg table from Glue and Hive catalog (#1331) * Use TABLE_TYPE --------- Co-authored-by: Wenzhuo Zhao <zhaowenzhuo01@bilibili.com> * Replace reference of `Table.identifier` with `Table.name` (#1346) * fix Table.name * replace Table.identifier with Table.name * add warning filter * Allow leading underscore in column name used in row filter (#1358) * Update parser.py Allow leading underscore in column name used in row filter. * Update test_parser.py * Update test_parser.py * Update test_parser.py * Remove Python 3.13 upper bound restriction (#1355) * Remove Python 3.13 upper bound restriction * Fix missing poetry.lock file * Upgrading numpy on the poetry.lock file from v1.26.0 to v1.26.4 * Improve documentation for "how to release" (#1359) * initial update * edits * add gpg instructions * verify artifacts * add twine not * grammar * edits * remove old artifacts * update doc workflow action * and name * add docs on patch vs major/minor release * fix `KeyError` raised by `add_files` when parquet file doe not have column stats (#1354) * fix KeyError, by switching del to pop * added unit test * update test * fix python 3.9 compatibility, and refactor test * update test * bump to 0.8.1 * Add instruction for patch release (#1373) * add instruction for patch release * create branch from tag * Write `null` when there is no parent-snapshot-id (#1383) --------- Co-authored-by: Sumanth <33193748+sumanth-manchala@users.noreply.github.com> Co-authored-by: gitzwz <72312233+gitzwz@users.noreply.github.com> Co-authored-by: Wenzhuo Zhao <zhaowenzhuo01@bilibili.com> Co-authored-by: vincenzon <mvcalder@gmail.com> Co-authored-by: Luca Bigon <luca.bigon@bauplanlabs.com> Co-authored-by: Binayak Dasgupta <binayakd86@gmail.com> Co-authored-by: Fokko Driesprong <fokko@apache.org>
kevinjqliu
added a commit
to kevinjqliu/iceberg-python
that referenced
this pull request
Nov 27, 2024
* initial update * edits * add gpg instructions * verify artifacts * add twine not * grammar * edits * remove old artifacts * update doc workflow action * and name * add docs on patch vs major/minor release
kevinjqliu
added a commit
that referenced
this pull request
Nov 27, 2024
* initial update * edits * add gpg instructions * verify artifacts * add twine not * grammar * edits * remove old artifacts * update doc workflow action * and name * add docs on patch vs major/minor release
sungwy
pushed a commit
to sungwy/iceberg-python
that referenced
this pull request
Dec 7, 2024
* initial update * edits * add gpg instructions * verify artifacts * add twine not * grammar * edits * remove old artifacts * update doc workflow action * and name * add docs on patch vs major/minor release
sungwy
pushed a commit
to sungwy/iceberg-python
that referenced
this pull request
Dec 7, 2024
* initial update * edits * add gpg instructions * verify artifacts * add twine not * grammar * edits * remove old artifacts * update doc workflow action * and name * add docs on patch vs major/minor release
sungwy
pushed a commit
to sungwy/iceberg-python
that referenced
this pull request
Dec 24, 2024
* initial update * edits * add gpg instructions * verify artifacts * add twine not * grammar * edits * remove old artifacts * update doc workflow action * and name * add docs on patch vs major/minor release
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1306
Uploaded the documentation for "how to release" based on recent experience with releasing 0.8.0 (See PyIceberg 0.8.0 release notes)
Additional potential improvements
ghcommand to trigger GitHub Actions and download artifacts (similar to iceberg-go release script)Python releasegithub action on tag push. Is it possible to run the release action once instead of twice (main + tag)?