doc.yaml

# 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: Doc

on:
  pull_request:
  push:

concurrency:
  group: ${{ github.head_ref || github.sha }}-${{ github.workflow }}
  cancel-in-progress: true

permissions:
  contents: write

jobs:
  publish:
    name: Publish
    timeout-minutes: 10
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: ruby
      - uses: actions/setup-python@v5
        with:
          python-version: 3
      - name: Install dependencies
        run: |
          pip3 install -r doc/requirements.txt
      - name: Build
        run: |
          rake doc:html
      - uses: actions/upload-artifact@v4
        with:
          name: doc
          path: doc/build
      - name: Prepare destination branch
        uses: actions/checkout@v4
        if: github.repository_owner == 'apache'
        with:
          fetch-depth: 0
          path: site
          persist-credentials: true
          ref: asf-site
      - name: Prepare destination branch for fork
        if: github.repository_owner != 'apache'
        run: |
          mkdir -p site.repository
          pushd site.repository
          git init --initial-branch=asf-site --bare
          popd
          git clone file://${PWD}/site.repository/ site
      - name: Publish
        run: |
          git config --global user.name 'github-actions[bot]'
          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
          rake doc:publish