From 0bf74876f5274510d12a559798178a8ee4f92055 Mon Sep 17 00:00:00 2001 From: luoyuxia Date: Mon, 30 Mar 2026 19:13:30 +0800 Subject: [PATCH] ci: add website workflow for gh-pages deployment --- .github/workflows/website.yml | 66 +++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 .github/workflows/website.yml diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml new file mode 100644 index 00000000..e4edf6f8 --- /dev/null +++ b/.github/workflows/website.yml @@ -0,0 +1,66 @@ +# 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: Website + +on: + push: + branches: + - main + pull_request: + paths: + - ".github/workflows/website.yml" + - "docs/**" + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }} + cancel-in-progress: true + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install docs dependencies + run: pip install mkdocs-material + + - name: Build + working-directory: docs + run: mkdocs build -f mkdocs.yml -d ../_site + + - name: Copy ASF config + run: cp .asf.yaml ./_site/.asf.yaml + + - name: Deploy to gh-pages + uses: peaceiris/actions-gh-pages@v4.0.0 + if: github.event_name == 'push' && github.ref_name == 'main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: _site + publish_branch: gh-pages