Merge pull request #253 from FusionAuth/miker/org.jetbrains.dokka-dropped-support

Use dokka v2 to generate html vs markdown documentation.

Author: mrudatsprint

.github/workflows/documentation.yml

@@ -0,0 +1,45 @@
+name: Deploy Dokka Docs
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup Java
+        uses: actions/setup-java@v5
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0
+
+      - name: Build Dokka HTML
+        run: ./gradlew dokkaGenerateHtml
+
+      - name: Determine deployment path
+        id: deploy-path
+        run: |
+            if [ "${{ github.ref }}" == "refs/heads/main" ]; then
+                echo "path=." >> $GITHUB_OUTPUT
+            else
+                BRANCH_NAME=$(echo ${{ github.ref }} | sed 's/refs\/heads\///' | sed 's/\//-/g')
+                echo "path=$BRANCH_NAME" >> $GITHUB_OUTPUT
+            fi
+            
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
+        with:
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            publish_dir: ./build/library/docs
+            destination_dir: ${{ steps.deploy-path.outputs.path }}
+            keep_files: true  # Important! Prevents deleting other directories
+

CONTRIBUTING.md

@@ -90,7 +90,6 @@ The pre-release process is as follows:
 - Compare the gradlew version `./gradlew -v` with the latest [gradle release](https://gradle.org/releases/) and update if necessary.
 - Review, test and merge any open [Dependency Pull Requests](https://github.com/FusionAuth/fusionauth-android-sdk/pulls).
 - Update the version in the `library/build.gradle.kts` file with a pre-release version according to the [Semantic Versioning](https://semver.org/) guidelines.
-- Update the documentation with `./gradlew dokkaGfm`.
 - Commit the changes with the commit message `chore(release): <pre-release-version> 🎉`.
 - Create a new tag `v<pre-release-version>`.
 - Make sure all Workflows where successful in [Actions](https://github.com/FusionAuth/fusionauth-android-sdk/actions).

README.md

@@ -199,7 +199,7 @@ end::forDocSiteQuickstart[]
 <!--
 tag::forDocSiteDocumentation[]
 -->
-See the latest [Full library documentation](https://github.com/FusionAuth/fusionauth-android-sdk/blob/main/library/docs/index.md) for the complete documentation of the SDK.
+See the latest [Full library documentation](https://fusionauth.github.io/fusionauth-android-sdk/index.html) for the complete documentation of the SDK.
 <!--
 end::forDocSiteDocumentation[]
 -->

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
     id("org.jetbrains.kotlin.android") version "2.2.0" apply false
     id("com.android.library") version "8.13.0" apply false
     id("io.gitlab.arturbosch.detekt") version "1.23.8"
-    id("org.jetbrains.dokka") version "2.0.0"
+    id("org.jetbrains.dokka") version "2.1.0"
     id("io.github.gradle-nexus.publish-plugin") version "2.0.0"
 
     kotlin("jvm") version "2.2.0"
@@ -48,4 +48,14 @@ nexusPublishing {
             password.set("your-password") // defaults to project.properties["myNexusPassword"]
         }
     }
+}
+
+dokka {
+    dokkaPublications.html {
+        outputDirectory.set(rootDir.resolve("build/library/docs"))
+
+        dokkaSourceSets.named("main") {
+            sourceRoots.from(file("library/src/main/java"))
+        }
+    }
 }

gradle.properties

@@ -20,4 +20,6 @@ kotlin.code.style=official
 # Enables namespacing of each library's R class so that its R class includes only the
 # resources declared in the library itself and none from the library's dependencies,
 # thereby reducing the size of the R class for that library
-android.nonTransitiveRClass=true
+android.nonTransitiveRClass=true
+# activates the DGP v2 plugin with migration helpers
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled

library/build.gradle.kts

@@ -183,7 +183,3 @@ dependencies {
     androidTestImplementation("androidx.test.ext:junit:1.3.0")
     androidTestImplementation("androidx.test.espresso:espresso-core:3.7.0")
 }
-
-tasks.dokkaGfm {
-    outputDirectory.set(layout.projectDirectory.dir("docs"))
-}