update_documentation.yml

name: Update Documentation

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master, develop ]

jobs:
  build_documentation:
    if: !contains(github.event.head_commit.message, '[maven-release-plugin]')
    name: Build Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Set up Java
        uses: actions/setup-java@v3
        with:
          java-version: '21'
          distribution: 'temurin'
          cache: 'maven'

      - name: Build JavaDoc with Maven
        run: |
          mvn -B javadoc:javadoc "-Dnotimestamp=true" "-Dcheckstyle.skipExec=true"
          mvn -B javadoc:jar  "-Dcheckstyle.skipExec=true"

      - name: Upload JavaDoc as HTML
        uses: actions/upload-artifact@v3
        with:
          name: JavaDoc
          path: ./target/site/apidocs

      - name: Upload JavaDoc as JAR
        uses: actions/upload-artifact@v3
        with:
          name: JavaDocJar
          path: ./target/misim-javadoc.jar


  push_documentation_to_gh-pages:
    name: Push Documentation to gh-pages
    if: github.event_name == 'push' && !contains(github.event.head_commit.message, '[maven-release-plugin]')
    needs: build_documentation
    runs-on: ubuntu-latest

    steps:
      - name: Download JavaDoc Artifact
        uses: actions/download-artifact@v3
        with:
          name: JavaDoc
          path: ~/docs/

      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Set up Git
        run: |
          git config --global committer.email "noreply@github.com"
          git config --global committer.name "GitHub Documentation Publish Workflow"
          git config --global author.email "${GITHUB_ACTOR}@users.noreply.github.com"
          git config --global author.name "${GITHUB_ACTOR}"

      - name: Checkout Files
        run: |
          git checkout gh-pages
          git pull
          cp -rpv ~/docs/. .

      - name: Check for changes
        run: |
          if git diff --quiet; then
            echo "CHANGES_EXIST=false" >> $GITHUB_ENV
          else
            echo "CHANGES_EXIST=true" >> $GITHUB_ENV
          fi
          echo "Changes exist: $CHANGES_EXIST"          

      - name: Commit Changes Files
        if: env.CHANGES_EXIST == 'true'
        run: |
          git commit -a -m "Updated documentation" --allow-empty

      - name: Push Changes
        if: env.CHANGES_EXIST == 'true'
        uses: ad-m/github-push-action@v0.6.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages