publish-javadoc.yaml

name: Deploy Javadoc

on:
  push:
    branches:
      - master
      - feature/doc
    tags:
      - '*'
  delete:

permissions:
  contents: write
  pages: write
  id-token: write

jobs:
  prune:
    if: github.event_name == 'delete'
    concurrency: javadoc-publish
    runs-on: ubuntu-latest
    outputs:
      result_hash: ${{ steps.deploy.outputs.hash }}
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
          ref: gh-pages
    
      - name: Deploy 🚀
        id: deploy
        shell: bash
        run: |
          if git rm -r $TARGET_FOLDER ; then
            echo Nothing to clean up
          fi
          
          find . -name javadoc -type d -print | sed 's#^\./\(.*\)/javadoc$#\1#' | sort --version-sort --reverse > index.txt
          git add index.txt
          git config user.name "${GITHUB_ACTOR}"
          git config user.email "${GITHUB_ACTOR_ID}-${GITHUB_ACTOR}@users.noreply.github.com"
          git commit -m "Clean up javadoc after ref $TARGET_FOLDER is deleted"
          git push
          echo "hash=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT            
        env:
          TARGET_FOLDER: ${{ github.ref_name }}
          
  javadoc:
    if: github.event_name == 'push'
    concurrency: javadoc-publish
    runs-on: ubuntu-latest
    outputs:
      result_hash: ${{ steps.deploy.outputs.hash }}
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - uses: actions/setup-java@v3
        with:
          java-version: |
            8
            11
            17
          distribution: 'temurin'
          cache: gradle

      - name: Grant execute permission for gradlew
        run: chmod +x gradlew

      - name: Generate Javadoc
        run: ./gradlew --no-daemon spotlessCheck javadoc

      - name: Deploy 🚀
        id: deploy
        shell: bash
        run: |
          mv build/docs $RUNNER_TEMP/docs_output
          rm build -rf
          git checkout gh-pages
          mkdir -p $TARGET_FOLDER
          rm -rf $TARGET_FOLDER
          mv $RUNNER_TEMP/docs_output $TARGET_FOLDER -v
          git add $TARGET_FOLDER
          if git diff --cached --exit-code > /dev/null ; then
            echo Nothing to deploy
            exit 0
          fi
          find . -name javadoc -type d -print | sed 's#^\./\(.*\)/javadoc$#\1#' | sort --version-sort --reverse > index.txt
          git add index.txt
          git config user.name "${GITHUB_ACTOR}"
          git config user.email "${GITHUB_ACTOR_ID}-${GITHUB_ACTOR}@users.noreply.github.com"
          git commit -m "Deploy javadoc from ref $TARGET_FOLDER"
          git push
          echo "hash=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
        env:
          TARGET_FOLDER: ${{ github.ref_name }}