Migrate to Dokka2 by geoff-powell · Pull Request #1783 · cashapp/paparazzi

geoff-powell · 2025-01-08T17:45:17Z

No description provided.

TWiStErRob · 2025-01-08T18:29:48Z

paparazzi/build.gradle

+  dokkaSourceSets.main {
+    reportUndocumented = false
+    skipDeprecated = true
+    jdkVersion = 17


Consider https://github.com/cashapp/paparazzi/blob/master/gradle/libs.versions.toml#L7

TWiStErRob · 2025-01-08T18:52:15Z

paparazzi/build.gradle

-tasks.named("dokkaGfm").configure {
-  outputDirectory = rootProject.file("docs/1.x")
+dokka {
+  dokkaPublications.configureEach {


If there are multiple they might overwrite each other, choose 1 with .named?

TWiStErRob · 2025-01-31T14:27:44Z

paparazzi/build.gradle

-        suppress = true
-      }
+    perPackageOption {
+      matchingRegex = "app.cash.paparazzi.internal.*"


. is special char in regex: I think the "correct" syntax in Groovy is

Suggested change

matchingRegex = "app.cash.paparazzi.internal.*"

matchingRegex = /app\.cash\.paparazzi\.internal\..*/

Although it will work most of the time with this pattern, it is still not using periods . as proper literals. Meaning any character might match.

This version is most likely the correct one to match app.cash.paparazzi.internal and all possible nested packages:

Suggested change

matchingRegex = "app.cash.paparazzi.internal.*"

matchingRegex = /app\.cash\.paparazzi\.internal(\..*)?/

@geoff-powell can you rebase your migration or was this PR paused on purpose?

Goooler · 2025-04-28T06:24:16Z

paparazzi/build.gradle

-  outputDirectory = rootProject.file("docs/1.x")
+dokka {
+  dokkaPublications.html {
+    outputDirectory.set(rootProject.file("docs/1.x"))


Suggested change

outputDirectory.set(rootProject.file("docs/1.x"))

outputDirectory = rootProject.file("docs/1.x")

should this also be 2.x now?

jrodbx · 2025-06-24T21:36:48Z

paparazzi/build.gradle

-  outputDirectory = rootProject.file("docs/1.x")
+dokka {
+  dokkaPublications.html {
+    outputDirectory.set(rootProject.file("docs/1.x"))


should this also be 2.x now?

jrodbx · 2025-06-24T21:53:42Z

gradle.properties

+
+# Dokka
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true


Suggested change

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

probably better to surface these sooner?

jrodbx · 2025-06-24T22:06:46Z

paparazzi/build.gradle

-tasks.named("dokkaGfm").configure {
-  outputDirectory = rootProject.file("docs/1.x")
+dokka {
+  dokkaPublications.html {


Suggested change

dokkaPublications.html {

dokkaPublications.named("html").configure {

jrodbx · 2025-06-24T22:07:05Z

paparazzi/build.gradle

+    outputDirectory.set(rootProject.file("docs/1.x"))
+  }
+
+  dokkaSourceSets.main {


Suggested change

dokkaSourceSets.main {

dokkaSourceSets.named("main").configure {

jrodbx · 2025-06-24T22:07:31Z

paparazzi/build.gradle

+  dokkaSourceSets.main {
+    reportUndocumented = false
+    skipDeprecated = true
+    jdkVersion = libs.versions.javaTarget.get() as int


jrodbx · 2025-06-24T22:13:00Z

paparazzi/build.gradle

-      perPackageOption {
-        prefix = "app.cash.paparazzi.internal"
-        suppress = true
-      }


rebase and keep:

skipEmptyPackages = true

and convert:

- includeNonPublic = false + documentedVisibilities(VisibilityModifier.Public)

- platform = "jvm" + analysisPlatform = KotlinPlatform.JVM

- externalDocumentationLink { - url.set(java.net.URL("https://developer.android.com/reference/")) - } + externalDocumentationLinks.register("docs") { + url("https://developer.android.com/reference/") + }

- sourceLink { - localDirectory.set(file("src/main/java")) - remoteUrl.set(java.net.URL("https://github.com/cashapp/paparazzi/tree/master/paparazzi/src/main/java")) - remoteLineSuffix.set("#L") - } + sourceLink { + localDirectory.set(file("src/main/java")) + remoteUrl("https://github.com/cashapp/paparazzi/tree/master/paparazzi/src/main/java") + remoteLineSuffix.set("#L") + }

TWiStErRob · 2025-07-09T11:49:16Z

docs/1.x/index.html

@@ -0,0 +1,183 @@
+<!DOCTYPE html>


Did you intentionally commit the output?

jrodbx

cool, let's land this and fast-follow on any breaks now that we've moved to a 2.x folder.

Also, per @TWiStErRob's comment, looks like the 1.x assets were committed. Assuming that's an accident, let's revert before merge?

jrodbx · 2025-07-21T18:05:38Z

mkdocs.yml

 nav:
  - 'Overview': index.md
-  - '1.x API': 1.x/paparazzi/app.cash.paparazzi/index.html
+  - '1.x API': 1.x/paparazzi/app.cash.paparazzi/index.md


making sure this was intentional, is the 1.x no longer using html?

jrodbx · 2025-07-21T21:25:45Z

.github/workflows/build.yml

+        with:
+          name: mkdocs-${{ github.sha }}
+          path: |
+            **/docs/


what's this addition for? shouldn't this covered in the build section below?

geoff-powell requested review from BrianGardnerAtl, gamepro65, jrodbx and nak5ive January 8, 2025 17:45

TWiStErRob reviewed Jan 8, 2025

View reviewed changes

geoff-powell force-pushed the gpowell/dokka2 branch from a298e0e to 22104cd Compare January 8, 2025 19:20

nak5ive approved these changes Jan 10, 2025

View reviewed changes

BrianGardnerAtl approved these changes Jan 29, 2025

View reviewed changes

TWiStErRob reviewed Jan 31, 2025

View reviewed changes

geoff-powell added this to the 2.0.0-alpha02 milestone Apr 11, 2025

Goooler reviewed Apr 28, 2025

View reviewed changes

jrodbx modified the milestones: 2.0.0-alpha02, 2.0.0-alpha03 Jun 20, 2025

jrodbx approved these changes Jun 24, 2025

View reviewed changes

geoff-powell force-pushed the gpowell/dokka2 branch 3 times, most recently from 5fa7ddd to ba063b3 Compare July 8, 2025 18:48

TWiStErRob reviewed Jul 9, 2025

View reviewed changes

docs/1.x/index.html Outdated

@@ -0,0 +1,183 @@

<!DOCTYPE html>

Copy link
Copy Markdown

Contributor

TWiStErRob Jul 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you intentionally commit the output?

jrodbx approved these changes Jul 18, 2025

View reviewed changes

geoff-powell force-pushed the gpowell/dokka2 branch from ba063b3 to 25dd537 Compare July 21, 2025 17:32

jrodbx reviewed Jul 21, 2025

View reviewed changes

geoff-powell force-pushed the gpowell/dokka2 branch 4 times, most recently from 01c030a to fe3043e Compare July 21, 2025 19:13

Cleanup and handle 2.x docs

d5cc660

geoff-powell force-pushed the gpowell/dokka2 branch from fe3043e to d5cc660 Compare July 21, 2025 19:20

geoff-powell merged commit ce2aadc into master Jul 21, 2025
22 checks passed

geoff-powell deleted the gpowell/dokka2 branch July 21, 2025 19:37

jrodbx reviewed Jul 21, 2025

View reviewed changes

geoff-powell added a commit that referenced this pull request Dec 1, 2025

Migrate to Dokka2 (#1783)

72ba1c2

	matchingRegex = "app.cash.paparazzi.internal.*"
	matchingRegex = /app\.cash\.paparazzi\.internal\..*/

	outputDirectory.set(rootProject.file("docs/1.x"))
	outputDirectory = rootProject.file("docs/1.x")

	dokkaPublications.html {
	dokkaPublications.named("html").configure {

	dokkaSourceSets.main {
	dokkaSourceSets.named("main").configure {

Conversation

geoff-powell commented Jan 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TWiStErRob Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrodbx left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

TWiStErRob Jan 31, 2025 •

edited

Loading