generate_docs.yml

name: Generate and publish docs

on:
  push:
    branches:
      - "release"

jobs:
  generate-and-publish-docs:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Set up JDK 11
        uses: actions/setup-java@v3
        with:
          distribution: adopt
          java-version: 11
          check-latest: true

      - name: Cache Gradle packages
        uses: actions/cache@v3
        with:
          path: |
            ~/.gradle/caches
            ~/.gradle/wrapper
            ~/.gradle/jdks
          key: ${{ runner.os }}-gradle-spark-${{ matrix.spark }}-${{ matrix.scala }}
          restore-keys: |
            ${{ runner.os }}-gradle-

      - name: Set Swap Space
        uses: pierotofy/set-swap-space@master
        with:
          swap-size-gb: 12

      - name: Generate docs with Gradle
        uses: gradle/gradle-build-action@v2
        with:
          arguments: |
            clean
            build
            dokkaHtmlMultiModule
            --scan

      - name: Copy docs to "docs" branch
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: docs
          publish_dir: ./build/dokka/htmlMultiModule
          force_orphan: true