.github/workflows/pages.yml - master - githubmirror/spark

.github/workflows/pages.yml
88 строк3 KB
Ruifeng Zheng
[SPARK-57782][INFRA][DOC] Make pages.yml reuse the doc image
15 июл 2026, 11:54
15 июл 2026, 11:54db5cbf1
#
# 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: GitHub Pages deployment

on:
  push:
    branches:
      - master

concurrency:
  group: 'docs preview'
  cancel-in-progress: false

jobs:
  docs:
    name: Build and deploy documentation
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      pages: write
    environment:
      name: github-pages # https://github.com/actions/deploy-pages/issues/271
    container:
      image: ghcr.io/apache/spark/apache-spark-github-action-image-docs-cache:master-static
    env:
      SPARK_TESTING: 1 # Reduce some noise in the logs
      RELEASE_VERSION: 'In-Progress'
      LC_ALL: C.UTF-8
      LANG: C.UTF-8
    if: github.repository == 'apache/spark'
    steps:
      - name: Checkout Spark repository
        uses: actions/checkout@v6
        with:
          repository: apache/spark
          ref: 'master'
      - name: Add GITHUB_WORKSPACE to git trust safe.directory
        run: |
          git config --global --add safe.directory ${GITHUB_WORKSPACE}
      - name: Free up disk space
        run: ./dev/free_disk_space_container
      - name: Install Java 17
        uses: actions/setup-java@v5
        with:
          distribution: zulu
          java-version: 17
      - name: Install dependencies for documentation generation
        run: |
          # Keep the version of Bundler here in sync with the following locations:
          #   - dev/create-release/spark-rm/Dockerfile
          #   - docs/README.md
          gem install bundler -v 2.4.22
          cd docs
          bundle install --retry=100
      - name: Run documentation build
        run: |
          sed -i".tmp1" 's/SPARK_VERSION:.*$/SPARK_VERSION: '"$RELEASE_VERSION"'/g' docs/_config.yml
          sed -i".tmp2" 's/SPARK_VERSION_SHORT:.*$/SPARK_VERSION_SHORT: '"$RELEASE_VERSION"'/g' docs/_config.yml
          sed -i".tmp3" "s/'facetFilters':.*$/'facetFilters': [\"version:$RELEASE_VERSION\"]/g" docs/_config.yml
          sed -i".tmp4" 's/__version__: str = .*$/__version__: str = "'"$RELEASE_VERSION"'"/' python/pyspark/version.py
          cd docs
          SKIP_RDOC=1 bundle exec jekyll build
      - name: Setup Pages
        uses: actions/configure-pages@v6
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: 'docs/_site'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5