Skip to content

dataconnect: demo: add "dokka" to generate ktdoc #7033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: dconeybe/dataconnect/DemoEmulatorExecutableProperty
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion .github/workflows/dataconnect_demo_app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,19 @@ jobs:
set -x
firebase-dataconnect/demo/gradlew \
--project-dir firebase-dataconnect/demo \
--no-daemon \
${{ (inputs.gradleInfoLog && '--info') || '' }} \
--profile \
-PdataConnect.demo.firebaseCommand=${{ env.FDC_FIREBASE_COMMAND }} \
assemble test

- name: gradle dokkaGeneratePublicationHtml
run: |
set -x
firebase-dataconnect/demo/gradlew \
--project-dir firebase-dataconnect/demo \
${{ (inputs.gradleInfoLog && '--info') || '' }} \
dokkaGeneratePublicationHtml

- uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
with:
name: apks
Expand All @@ -126,6 +133,13 @@ jobs:
if-no-files-found: warn
compression-level: 9

- uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
with:
name: ktdoc
path: firebase-dataconnect/demo/build/dokka/html
if-no-files-found: warn
compression-level: 9

spotlessCheck:
continue-on-error: false
runs-on: ubuntu-latest
Expand Down
9 changes: 9 additions & 0 deletions firebase-dataconnect/demo/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ plugins {
// The following code in this "plugins" block can be omitted from customer
// facing documentation as it is an implementation detail of this application.
id("com.diffplug.spotless") version "7.0.0.BETA4"

id("org.jetbrains.dokka") version "2.0.0"
}

dependencies {
Expand All @@ -55,6 +57,13 @@ dependencies {
implementation("io.kotest.extensions:kotest-property-arbs:2.1.2")
}

dokka {
moduleName.set("Data Connect Demo")
dokkaSourceSets.main {
sourceRoots.from(layout.buildDirectory.dir("dataConnect/generatedSources/").get())
}
}

// The remaining code in this file can be omitted from customer facing
// documentation. It's here just to make things compile and/or configure
// optional components of the build (e.g. spotless code formatting).
Expand Down
3 changes: 3 additions & 0 deletions firebase-dataconnect/demo/gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ android.useAndroidX=true

org.gradle.jvmargs=-Xmx2g

org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true

// The path of the "firebase" command to use.
// If not specified, then "firebase" is used, resolved using the PATH environment variable.
// See build.gradle.kts for details.
Expand Down
Loading