.github/workflows/docs.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 documentation"
on:
  schedule:
    - cron: '0 0 * * *' # Deploy every day
  workflow_dispatch:

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

jobs:
  build-documentation:
    if: github.repository == 'apache/flink'
    runs-on: ubuntu-latest
    strategy:
      max-parallel: 1
      matrix:
        branch:
          - master
          - release-2.3
          - release-2.2
          - release-2.1
          - release-2.0
          - release-1.20
          - release-1.19
    steps:
      - uses: actions/checkout@v7
        with:
          ref: ${{ matrix.branch }}

      - name: Set branch environment variable
        run: |
          currentBranch=$(git branch --show-current)

          echo "flink_branch=${currentBranch}" >> ${GITHUB_ENV}

          if [ "${currentBranch}" = "master" ]; then
            echo "flink_alias=release-2.4" >> ${GITHUB_ENV}
          elif [ "${currentBranch}" = "release-2.3" ]; then
            echo "flink_alias=stable" >> ${GITHUB_ENV}
          elif [ "${currentBranch}" = "release-1.20" ]; then
            echo "flink_alias=lts" >> ${GITHUB_ENV}
          fi

      - name: Cache Maven dependencies
        uses: actions/cache@v5
        with:
          path: ~/.m2/repository
          key: ${{ runner.os }}-maven-docs-${{ hashFiles('**/pom.xml') }}
          restore-keys: |
            ${{ runner.os }}-maven-docs-

      - name: Build documentation
        run: |
          docker run --rm \
            --volume "$PWD:/root/flink" \
            --volume "$HOME/.m2/repository:/root/.m2/repository" \
            apache/flink-ci-docker:java_8_11_17_21_25_maven_386_jammy \
            bash -c "cd /root/flink && ./.github/workflows/docs.sh"

      - name: Upload documentation
        uses: burnett01/rsync-deployments@66257cad6bfeb2171d3b6bfa6c9a22279dd9c3a1 # 8.0.5
        with:
          switches: --archive --compress --delete
          path: docs/target/
          remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/flink/flink-docs-${{ env.flink_branch }}/
          remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }}
          remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }}
          remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }}
          remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }}

      - name: Upload documentation alias
        if: env.flink_alias != ''
        uses: burnett01/rsync-deployments@66257cad6bfeb2171d3b6bfa6c9a22279dd9c3a1 # 8.0.5
        with:
          switches: --archive --compress --delete
          path: docs/target/
          remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/flink/flink-docs-${{ env.flink_alias }}/
          remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }}
          remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }}
          remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }}
          remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }}