From b7144a8f21a32548ea82937a5b62c44967770549 Mon Sep 17 00:00:00 2001 From: ogaclejapan Date: Mon, 29 Apr 2024 15:49:15 +0900 Subject: [PATCH 1/2] Configure dokka plugin --- Makefile | 4 ++++ build.gradle.kts | 2 +- soil-form/build.gradle.kts | 1 + soil-query-compose-runtime/build.gradle.kts | 1 + soil-query-compose/build.gradle.kts | 1 + soil-query-core/build.gradle.kts | 1 + soil-space/build.gradle.kts | 1 + 7 files changed, 10 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index e2fbc35..fcfe979 100644 --- 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 index 89716d1..28e5589 100644 --- 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 index c4f638c..665beb3 100644 --- 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() diff --git a/soil-query-compose-runtime/build.gradle.kts b/soil-query-compose-runtime/build.gradle.kts index 0bca6f1..f118101 100644 --- 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() diff --git a/soil-query-compose/build.gradle.kts b/soil-query-compose/build.gradle.kts index f55077a..2bccd7c 100644 --- 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() diff --git a/soil-query-core/build.gradle.kts b/soil-query-core/build.gradle.kts index dc3a6e3..d0c753e 100644 --- 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() diff --git a/soil-space/build.gradle.kts b/soil-space/build.gradle.kts index f47e334..820d01a 100644 --- 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() From 617db34d33c0b906b5b761a09a2b828d214b8d72 Mon Sep 17 00:00:00 2001 From: ogaclejapan Date: Mon, 29 Apr 2024 17:22:16 +0900 Subject: [PATCH 2/2] Integrate api-reference deployment step into the release workflow --- .github/workflows/publish.yml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 0320fd8..93bb599 100644 --- 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