name: Publish Dokka API documentation

on:
  release:
    types: [published]
  workflow_dispatch:

jobs:
  publish-docs:
    name: Publish docs
    runs-on: ubuntu-latest

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

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Java
        uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: 21

      - name: Setup Gradle
        uses: gradle/actions/setup-gradle@v4
        with:
          build-scan-publish: true
          build-scan-terms-of-use-url: "https://gradle.com/help/legal-terms-of-use"
          build-scan-terms-of-use-agree: "yes"
          cache-read-only: false

      - name: Generate Dokka multi-module documentation
        run: ./gradlew :tools:aggregate-docs:dokkaGenerate

      - name: Upload output artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: tools/aggregate-docs/build/dokka/html/

      - name: Deploy to GH Pages
        id: deployment
        uses: actions/deploy-pages@v4