From d603b12952f3fd88b367eea49a2e4e10eae6aadb Mon Sep 17 00:00:00 2001 From: Kevin Liu Date: Thu, 21 Nov 2024 16:02:08 -0800 Subject: [PATCH 1/3] add ci to release docs --- .github/workflows/python-release-docs.yml | 56 +++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 .github/workflows/python-release-docs.yml 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 From aec8823e65f0e57d768fcd1b8f36ae06fefdfde3 Mon Sep 17 00:00:00 2001 From: Kevin Liu Date: Thu, 21 Nov 2024 16:03:21 -0800 Subject: [PATCH 2/3] run mkdocs in ci --- .github/workflows/python-ci-docs.yml | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/.github/workflows/python-ci-docs.yml b/.github/workflows/python-ci-docs.yml index 0ee8b28c7a..23e5a7e033 100644 --- a/.github/workflows/python-ci-docs.yml +++ b/.github/workflows/python-ci-docs.yml @@ -17,9 +17,13 @@ # under the License. # -name: "Python Docs" +name: "Python CI Docs" on: - workflow_dispatch: + push: + branches: + - 'main' + pull_request: + concurrency: group: ${{ github.workflow }}-${{ github.ref }} @@ -40,17 +44,3 @@ jobs: - 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 From 13e558cba48338f3a113176d7f5d924782e13c97 Mon Sep 17 00:00:00 2001 From: Kevin Liu Date: Thu, 21 Nov 2024 16:12:23 -0800 Subject: [PATCH 3/3] use 3.12 --- .github/workflows/python-ci-docs.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/python-ci-docs.yml b/.github/workflows/python-ci-docs.yml index 23e5a7e033..19c4bb6ac1 100644 --- a/.github/workflows/python-ci-docs.yml +++ b/.github/workflows/python-ci-docs.yml @@ -18,10 +18,11 @@ # name: "Python CI Docs" + on: push: branches: - - 'main' + - 'main' pull_request: @@ -37,7 +38,7 @@ 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