Merge pull request #9 from soil-kt/dokka

Use dokka
soil-kt · Apr 29, 2024 · 65a4534 · 65a4534
2 parents 04048c0 + 617db34
commit 65a4534
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 1 deletion.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -1,6 +1,12 @@
 name: Publish
 on:
  workflow_dispatch:
+ inputs:
+ deploy_api_reference:
+ description: 'Deploy API Reference?'
+ required: true
+ default: true
+ type: boolean
 
 jobs:
  publish:
@@ -9,6 +15,9 @@ jobs:
  permissions:
  contents: write
 
+ env:
+ RELEASE_PAGES_BRANCH: main
+
  steps:
  - name: Check branch
  if: ${{ !contains(github.ref, 'refs/heads/release/') }}
@@ -49,3 +58,14 @@ jobs:
  ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
  ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_KEY }}
  ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.GPG_KEY_PASSWORD }}
+
+ - name: Build API Reference
+ if: ${{ github.event.inputs.deploy_api_reference == 'true' }}
+ run: ./gradlew dokkaHtmlMultiModule
+
+ - name: Deploy API Reference to Cloudflare Pages
+ if: ${{ github.event.inputs.deploy_api_reference == 'true' }}
+ uses: cloudflare/wrangler-action@v3
+ with:
+ apiToken: ${{ secrets.CLOUDFLARE_PAGES_DEPLOY_API_TOKEN }}
+ command: pages deploy build/dokka/htmlMultiModule --project-name=soil-api-reference --branch $RELEASE_PAGES_BRANCH
diff --git a/Makefile b/Makefile
@@ -17,6 +17,10 @@ dist.wasm:
 fmt:
  @$(GRADLE_CMD) spotlessApply
 
+.PHONY: dokka
+dokka:
+ @$(GRADLE_CMD) dokkaHtmlMultiModule
+
 .PHONY: publish
 publish:
  @$(GRADLE_CMD) publish

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -5,7 +5,7 @@ plugins {
  alias(libs.plugins.kotlin.multiplatform) apply false
  alias(libs.plugins.kotlin.serialization) apply false
  alias(libs.plugins.maven.publish) apply false
- alias(libs.plugins.dokka) apply false
+ alias(libs.plugins.dokka)
  alias(libs.plugins.spotless)
 }
 

diff --git a/soil-form/build.gradle.kts b/soil-form/build.gradle.kts
@@ -5,6 +5,7 @@ plugins {
  alias(libs.plugins.compose.multiplatform)
  alias(libs.plugins.kotlin.multiplatform)
  alias(libs.plugins.maven.publish)
+ alias(libs.plugins.dokka)
 }
 
 val buildTarget = the<BuildTargetExtension>()

diff --git a/soil-query-compose-runtime/build.gradle.kts b/soil-query-compose-runtime/build.gradle.kts
@@ -5,6 +5,7 @@ plugins {
  alias(libs.plugins.compose.multiplatform)
  alias(libs.plugins.kotlin.multiplatform)
  alias(libs.plugins.maven.publish)
+ alias(libs.plugins.dokka)
 }
 
 val buildTarget = the<BuildTargetExtension>()

diff --git a/soil-query-compose/build.gradle.kts b/soil-query-compose/build.gradle.kts
@@ -8,6 +8,7 @@ plugins {
  alias(libs.plugins.compose.multiplatform)
  alias(libs.plugins.kotlin.multiplatform)
  alias(libs.plugins.maven.publish)
+ alias(libs.plugins.dokka)
 }
 
 val buildTarget = the<BuildTargetExtension>()

diff --git a/soil-query-core/build.gradle.kts b/soil-query-core/build.gradle.kts
@@ -4,6 +4,7 @@ plugins {
  alias(libs.plugins.android.library)
  alias(libs.plugins.kotlin.multiplatform)
  alias(libs.plugins.maven.publish)
+ alias(libs.plugins.dokka)
 }
 
 val buildTarget = the<BuildTargetExtension>()

diff --git a/soil-space/build.gradle.kts b/soil-space/build.gradle.kts
@@ -6,6 +6,7 @@ plugins {
  alias(libs.plugins.compose.multiplatform)
  alias(libs.plugins.kotlin.multiplatform)
  alias(libs.plugins.maven.publish)
+ alias(libs.plugins.dokka)
 }
 
 val buildTarget = the<BuildTargetExtension>()