From 788932eb62cf1d2df270e8da4c9bd3bfe57048a5 Mon Sep 17 00:00:00 2001 From: Kevin Liu Date: Sun, 16 Feb 2025 17:52:21 -0800 Subject: [PATCH 1/4] add docs about nightly build --- mkdocs/docs/SUMMARY.md | 1 + mkdocs/docs/nightly-build.md | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 mkdocs/docs/nightly-build.md diff --git a/mkdocs/docs/SUMMARY.md b/mkdocs/docs/SUMMARY.md index 8d384f8a31..742559ddfd 100644 --- a/mkdocs/docs/SUMMARY.md +++ b/mkdocs/docs/SUMMARY.md @@ -29,6 +29,7 @@ - Releases - [Verify a release](verify-release.md) - [How to release](how-to-release.md) + - [Nightly Build](nightly-build.md) - [Release Notes](https://github.com/apache/iceberg-python/releases) - [Code Reference](reference/) diff --git a/mkdocs/docs/nightly-build.md b/mkdocs/docs/nightly-build.md new file mode 100644 index 0000000000..903b2f4a2c --- /dev/null +++ b/mkdocs/docs/nightly-build.md @@ -0,0 +1,27 @@ + + +# Nightly Build + +A nightly build of PyIceberg is available on testpypi, [https://test.pypi.org/project/pyiceberg/](https://test.pypi.org/project/pyiceberg/). + +To install the nightly build, +``` +pip install -i https://test.pypi.org/simple/ --pre pyiceberg +``` From 0349ebbd53ab5caf2ada0998b3497c82352c0484 Mon Sep 17 00:00:00 2001 From: Kevin Liu Date: Sun, 16 Feb 2025 17:54:50 -0800 Subject: [PATCH 2/4] make lint --- mkdocs/docs/nightly-build.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/mkdocs/docs/nightly-build.md b/mkdocs/docs/nightly-build.md index 903b2f4a2c..83feb6bd78 100644 --- a/mkdocs/docs/nightly-build.md +++ b/mkdocs/docs/nightly-build.md @@ -21,7 +21,8 @@ A nightly build of PyIceberg is available on testpypi, [https://test.pypi.org/project/pyiceberg/](https://test.pypi.org/project/pyiceberg/). -To install the nightly build, -``` +To install the nightly build, + +```shell pip install -i https://test.pypi.org/simple/ --pre pyiceberg ``` From 93c6be42cd8676d36df021d197244d8408f0e5e2 Mon Sep 17 00:00:00 2001 From: Kevin Liu Date: Mon, 17 Feb 2025 12:12:13 -0500 Subject: [PATCH 3/4] Update mkdocs/docs/SUMMARY.md Co-authored-by: Fokko Driesprong --- mkdocs/docs/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/docs/SUMMARY.md b/mkdocs/docs/SUMMARY.md index 742559ddfd..c344b2fdd2 100644 --- a/mkdocs/docs/SUMMARY.md +++ b/mkdocs/docs/SUMMARY.md @@ -29,8 +29,8 @@ - Releases - [Verify a release](verify-release.md) - [How to release](how-to-release.md) - - [Nightly Build](nightly-build.md) - [Release Notes](https://github.com/apache/iceberg-python/releases) + - [Nightly Build](nightly-build.md) - [Code Reference](reference/) From d97b87cace34865fd26c873743788b928838872a Mon Sep 17 00:00:00 2001 From: Kevin Liu Date: Mon, 17 Feb 2025 09:25:10 -0800 Subject: [PATCH 4/4] add warning --- mkdocs/docs/nightly-build.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/mkdocs/docs/nightly-build.md b/mkdocs/docs/nightly-build.md index 83feb6bd78..386e923402 100644 --- a/mkdocs/docs/nightly-build.md +++ b/mkdocs/docs/nightly-build.md @@ -26,3 +26,10 @@ To install the nightly build, ```shell pip install -i https://test.pypi.org/simple/ --pre pyiceberg ``` + + + +!!! warning "For Testing Purposes Only" + Nightly builds are for testing purposes only and have not been validated. Please use at your own risk, as they may contain untested changes, potential bugs, or incomplete features. Additionally, ensure compliance with any applicable licenses, as these builds may include changes that have not been reviewed for legal or licensing implications. + +