From fc3bdbc683d3bb84a64ccb3ba08b87951dbb6daa Mon Sep 17 00:00:00 2001
From: Kevin Liu <kevinjqliu@users.noreply.github.com>
Date: Fri, 22 Nov 2024 11:39:17 -0500
Subject: [PATCH] check mkdocs build strict in CI (#1360)

* add ci to release docs

* run mkdocs in ci

* use 3.12
---
 .github/workflows/python-ci-docs.yml      | 25 ++++------
 .github/workflows/python-release-docs.yml | 56 +++++++++++++++++++++++
 2 files changed, 64 insertions(+), 17 deletions(-)
 create mode 100644 .github/workflows/python-release-docs.yml

diff --git a/.github/workflows/python-ci-docs.yml b/.github/workflows/python-ci-docs.yml
index 0ee8b28c7a..19c4bb6ac1 100644
--- a/.github/workflows/python-ci-docs.yml
+++ b/.github/workflows/python-ci-docs.yml
@@ -17,9 +17,14 @@
 # under the License.
 #
 
-name: "Python Docs"
+name: "Python CI Docs"
+
 on:
-  workflow_dispatch:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -33,24 +38,10 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python }}
+          python-version: 3.12
       - name: Install
         working-directory: ./mkdocs
         run: pip install -r requirements.txt
       - name: Build
         working-directory: ./mkdocs
         run: mkdocs build --strict
-      - name: Copy
-        working-directory: ./mkdocs
-        run: mv ./site /tmp/site
-      - name: Push changes to gh-pages branch
-        run: |
-          git checkout --orphan gh-pages-tmp
-          git rm --quiet -rf .
-          cp -r /tmp/site/* .
-          git config --global user.name 'GitHub Actions'
-          git config --global user.email 'actions@github.com'
-          echo "py.iceberg.apache.org" > CNAME
-          git add --all
-          git commit -m 'Publish Python docs'
-          git push -f origin gh-pages-tmp:gh-pages || true
diff --git a/.github/workflows/python-release-docs.yml b/.github/workflows/python-release-docs.yml
new file mode 100644
index 0000000000..2f1b1155e9
--- /dev/null
+++ b/.github/workflows/python-release-docs.yml
@@ -0,0 +1,56 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+name: "Release Docs"
+on:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  docs:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install
+        working-directory: ./mkdocs
+        run: pip install -r requirements.txt
+      - name: Build
+        working-directory: ./mkdocs
+        run: mkdocs build --strict
+      - name: Copy
+        working-directory: ./mkdocs
+        run: mv ./site /tmp/site
+      - name: Push changes to gh-pages branch
+        run: |
+          git checkout --orphan gh-pages-tmp
+          git rm --quiet -rf .
+          cp -r /tmp/site/* .
+          git config --global user.name 'GitHub Actions'
+          git config --global user.email 'actions@github.com'
+          echo "py.iceberg.apache.org" > CNAME
+          git add --all
+          git commit -m 'Publish Python docs'
+          git push -f origin gh-pages-tmp:gh-pages || true