build.yml

# 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: "Build website and document"

env:
  versions: ("master" "1.4") # defines what versions of document should be updated
  latest_version: "1.4" # defines what version docs/latest links to
  base_href: "https://paimon.apache.org/" # website base href

on:
  workflow_dispatch:
  schedule:
    - cron: '0 0 * * *' # deploy every day

jobs:
  build-website:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up JDK 1.8
        uses: actions/setup-java@v1
        with:
          java-version: 1.8

      - name: Set up pnpm v9
        uses: pnpm/action-setup@v4
        with:
          version: 9
          run_install: false

      - name: Set up Node.js 20 LTS
        uses: actions/setup-node@v4
        with:
          node-version: 20.x

      - name: Enable yarn
        run: corepack enable yarn

      - name: Copy out old docs directory
        run: |
          git fetch origin asf-site:asf-site
          git checkout asf-site
          if [[ -d docs ]]
          then
            cp -r docs /tmp/docs
          else
            mkdir /tmp/docs
          fi

      - name: Create asf-site branch
        run: |
          git checkout master
          git branch -D asf-site
          git checkout --orphan asf-site

      - name: Copy back docs directory
        run: cp -r /tmp/docs docs

      - name: Build Website
        run: |
          # move to temporary directory for building website
          mkdir /tmp/main
          mv * /tmp/main
          cd /tmp/main
          # build website
          npm config --global set registry https://registry.npmmirror.com/
          pnpm install
          pnpm run build --base-href="${{ env.base_href }}"

      - name: Move out output
        run: |
          mv /tmp/docs .
          mv /tmp/main/dist/browser/* .
          rm -rf /tmp/main

      - name: Clone Paimon repo
        run: git clone https://github.com/apache/paimon.git /tmp/paimon

      - name: Build docs
        run: |
          declare -a versions=${{ env.versions }}
          current_dir=$(pwd)
          cp ./.github/workflows/docs.sh /tmp/docs.sh
          for version in "${versions[@]}"
          do
            # delete old document
            rm -rf docs/"$version"
            mkdir docs/"$version"
            # build new document
            cd /tmp/paimon
            git checkout master
            if [ "$version" != "master" ]
            then
              git checkout release-"$version"
            fi
            # master or version >= 1.5 uses Docusaurus, otherwise Hugo
            if [ "$version" == "master" ] || [ "$(echo "$version" | awk -F. '{print ($1 * 100 + $2)}')" -ge 105 ]; then
              cd docs
              sed -i "s|baseUrl: '/docs/master/'|baseUrl: '/docs/$version/'|g" docusaurus.config.js
              yarn install --frozen-lockfile
              yarn build
              cp -r build/* "$current_dir"/docs/"$version"
              cd /tmp/paimon
            else
              . /tmp/docs.sh
              cp -r docs/target/* "$current_dir"/docs/"$version"
            fi
            # clean up
            git reset --hard HEAD
            git clean -fdx
            cd "$current_dir"
          done

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      - name: Clone Paimon Rust repo
        run: git clone https://github.com/apache/paimon-rust.git /tmp/paimon-rust

      - name: Build Paimon Rust docs
        run: |
          pip install mkdocs-material
          cd /tmp/paimon-rust/docs
          mkdocs build -d /tmp/paimon-rust-site
          cd $GITHUB_WORKSPACE
          rm -rf docs/rust
          mkdir -p docs/rust
          cp -r /tmp/paimon-rust-site/* docs/rust/

      - name: Clone Paimon CPP repo
        run: git clone --depth 1 https://github.com/apache/paimon-cpp.git /tmp/paimon-cpp

      - name: Build Paimon CPP docs
        run: |
          sudo apt-get update
          sudo apt-get install -y doxygen
          pip install -r /tmp/paimon-cpp/docs/requirements.txt
          cd /tmp/paimon-cpp/apidoc
          doxygen
          cd /tmp/paimon-cpp/docs
          make html
          cd $GITHUB_WORKSPACE
          rm -rf docs/cpp
          mkdir -p docs/cpp
          cp -r /tmp/paimon-cpp/docs/_build/html/* docs/cpp/

      - name: Clone Paimon Mosaic repo
        run: git clone --depth 1 https://github.com/apache/paimon-mosaic.git /tmp/paimon-mosaic

      - name: Build Paimon Mosaic docs
        run: |
          rm -rf docs/mosaic
          mkdir -p docs/mosaic
          cp -r /tmp/paimon-mosaic/docs/* docs/mosaic/

      - name: Push to github
        run: |
          git add -A
          git config --global user.name 'GitHub Actions'
          git config --global user.email 'actions@github.com'
          git commit -m "Build website and document"
          git push -f origin asf-site