You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by bl...@apache.org on 2023/02/07 16:27:26 UTC
[iceberg] branch master updated: Python: Publish the docs by hand (#6719)
This is an automated email from the ASF dual-hosted git repository.
blue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iceberg.git
The following commit(s) were added to refs/heads/master by this push:
new cce25865cf Python: Publish the docs by hand (#6719)
cce25865cf is described below
commit cce25865cfd3dffbb9b08bfb473ca98ea160b357
Author: Fokko Driesprong <fo...@apache.org>
AuthorDate: Tue Feb 7 17:27:19 2023 +0100
Python: Publish the docs by hand (#6719)
Currently everything that goes into master will directly be pushed
to Github Pages. This was fine for a while, but now we have PRs that
publish new functionality, but then it isn't available in the release
for example: https://github.com/apache/iceberg/pull/6644
I think we should now publish by hand, and move to multi version docs
once PyIceberg stabilizes a bit.
---
.github/workflows/python-ci-docs.yml | 7 +------
python/mkdocs/docs/how-to-release.md | 4 ++++
2 files changed, 5 insertions(+), 6 deletions(-)
diff --git a/.github/workflows/python-ci-docs.yml b/.github/workflows/python-ci-docs.yml
index 66d153f624..71082d5e04 100644
--- a/.github/workflows/python-ci-docs.yml
+++ b/.github/workflows/python-ci-docs.yml
@@ -19,12 +19,7 @@
name: "Python Docs"
on:
- push:
- branches:
- - 'master'
- paths:
- - 'python/mkdocs/**'
- - '.github/workflows/python-ci-docs.yml'
+ workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
diff --git a/python/mkdocs/docs/how-to-release.md b/python/mkdocs/docs/how-to-release.md
index ca6c917f9c..4b5c6345a9 100644
--- a/python/mkdocs/docs/how-to-release.md
+++ b/python/mkdocs/docs/how-to-release.md
@@ -162,3 +162,7 @@ This Python release can be downloaded from: https://pypi.org/project/pyiceberg/<
Thanks to everyone for contributing!
```
+
+## Release the docs
+
+A committer triggers the `Python Docs` Github Actions through the UI by selecting the branch that just has been released. This will publish the new docs.