force dependency resolution for the current version of androidx-lifecycle

Author: RBusarow

.buildscript/android-ui-tests.gradle

@@ -11,8 +11,7 @@ android {
 
 dependencies {
   androidTestImplementation project(":workflow-ui:internal-testing-android")
-
-  implementation(libs.androidx.test.espresso.core)
-  implementation(libs.androidx.test.junit)
-  implementation(libs.squareup.leakcanary.instrumentation)
+  androidTestImplementation(libs.androidx.test.espresso.core)
+  androidTestImplementation(libs.androidx.test.junit)
+  androidTestImplementation(libs.squareup.leakcanary.instrumentation)
 }

.editorconfig

@@ -9,7 +9,7 @@
 #
 # Some keys were manually changed:
 #   * insert_final_newline (is false, changed to true, expected by KtLint)
-#   * kotlin_imports_layout (see comment below, needed for KtLint)
+#   * ktlint_ignore_back_ticked_identifier (enabled, see comment below)
 #   * root (see comment below)
 
 # Tells tools to stop searching upwards.
@@ -30,10 +30,9 @@ ij_formatter_tags_enabled = false
 ij_smart_tabs = false
 ij_wrap_on_typing = false
 
-# This config is needed for KtLint. It configures the import rule order to use IntelliJ IDEA's
-# default style, see also:
-# https://github.com/pinterest/ktlint#custom-ktlint-specific-editorconfig-properties
-kotlin_imports_layout = *,java.**,javax.**,kotlin.**,^
+# Back-ticked method names are allowed to exceed the line length. That's especially helpful for
+# test methods with descriptive names.
+ktlint_ignore_back_ticked_identifier = true
 
 [*.java]
 ij_java_align_consecutive_assignments = false

README.md

@@ -64,7 +64,7 @@ your `repositories` block, and then add dependencies on the following artifacts:
     <td>Your Android app uses modals (popups).</td>
   </tr>
   <tr>
-    <td nowrap><code>com.squareup.workflow1:workflow-ui-backstack-android:x.y.z</code></td>
+    <td nowrap><code>com.squareup.workflow1:workflow-ui-container-android:x.y.z</code></td>
     <td>Your android app uses backstacks.</td>
   </tr>
 </table>

RELEASING.md

@@ -10,6 +10,11 @@
    ./gradlew build connectedCheck
    ```
 
+1. Update your tags.
+   ```bash
+   git fetch --tags
+   ```
+
 1. In `gradle.properties`, remove the `-SNAPSHOT` suffix from the `VERSION_NAME` property.
    E.g. `VERSION_NAME=0.1.0`
 
@@ -38,11 +43,11 @@
    git commit -am "Finish releasing v0.1.0."
    ```
 
-1. Push your commits and tag:
+1. Push your commits and tags:
    ```
-   git push origin main
+   git push origin main && git push --tags
    # or git push origin fix-branch
-   git push origin v0.1.0
+   git push origin v0.1.0 && git push --tags
    ```
 
 1. Create the release on GitHub:
@@ -119,6 +124,23 @@ mavenCentralUsername=<username>
 mavenCentralPassword=<password>
 ```
 
+In order to sign you'll need to specify your GPG key config in your private
+Gradle properties file(`~/.gradle/gradle.properties`).
+
+```
+signing.keyId=<keyid>
+signing.password=<password>
+signing.secretKeyRingFile=<path/to/secring.gpg>
+```
+
+If this is your first time for either, the following one time steps need
+to be performed:
+
+1. Sign up for a Sonatype JIRA account.
+1. Generate a GPG key (if you don't already have one). [Instructions](https://central.sonatype.org/publish/requirements/gpg/#generating-a-key-pair).
+1. Distribute the GPG key to public servers. [Instructions](https://central.sonatype.org/publish/requirements/gpg/#distributing-your-public-key).
+1. Get access to deploy under 'com.squareup' from Sonatype.
+
 #### Snapshot Releases
 
 Double-check that `gradle.properties` correctly contains the `-SNAPSHOT` suffix, then upload

build.gradle.kts

@@ -11,6 +11,7 @@ buildscript {
     classpath(libs.kotlin.serialization.gradle.plugin)
     classpath(libs.kotlinx.binaryCompatibility.gradle.plugin)
     classpath(libs.kotlin.gradle.plugin)
+    classpath(libs.google.ksp)
     classpath(libs.ktlint.gradle)
     classpath(libs.vanniktech.publish)
   }
@@ -61,28 +62,6 @@ subprojects {
       // Default "plain" reporter is actually harder to read.
       reporter(ReporterType.JSON)
     }
-
-    disabledRules.set(
-      setOf(
-        // IntelliJ refuses to sort imports correctly.
-        // This is a known issue: https://github.com/pinterest/ktlint/issues/527
-        "import-ordering",
-
-        // We had to disable the indent and parameter-list-wrapping rules, because they lead to
-        // false positives even in the most recent KtLint version. We created tickets:
-        //
-        // https://github.com/pinterest/ktlint/issues/963
-        // https://github.com/pinterest/ktlint/issues/964
-        // https://github.com/pinterest/ktlint/issues/965
-        //
-        // We can't revert the KtLint version, because they only work with Kotlin 1.3 and would
-        // block Kotlin 1.4. We rather have a newer Kotlin version than a proper indent. The
-        // indent rule needs to be disabled globally due to another bug:
-        // https://github.com/pinterest/ktlint/issues/967
-        "indent",
-        "parameter-list-wrapping"
-      )
-    )
   }
 }
 
@@ -138,6 +117,20 @@ subprojects {
   }
 }
 
+allprojects {
+
+  configurations.all {
+    resolutionStrategy.eachDependency {
+      // This ensures that any time a dependency has a transitive dependency upon androidx.lifecycle,
+      // it uses the same version as the rest of the project.  This is crucial, since Androidx
+      // libraries are never in sync and lifecycle 2.4.0 introduced api-breaking changes.
+      if (requested.group == "androidx.lifecycle") {
+        useVersion(libs.versions.androidx.lifecycle.get())
+      }
+    }
+  }
+}
+
 // This task is invoked by the documentation site generator script in the main workflow project (not
 // in this repo), which also expects the generated files to be in a specific location. Both the task
 // name and destination directory are defined in this script:

gradle.properties

@@ -8,7 +8,7 @@ android.useAndroidX=true
 systemProp.org.gradle.internal.publish.checksums.insecure=true
 
 GROUP=com.squareup.workflow1
-VERSION_NAME=1.5.0-SNAPSHOT
+VERSION_NAME=1.6.0-SNAPSHOT
 
 POM_DESCRIPTION=Square Workflow
 

gradle/libs.versions.toml

@@ -33,6 +33,7 @@ dokka = "1.5.31"
 
 google-accompanist = "0.18.0"
 google-dagger = "2.40.5"
+google-ksp = "1.6.10-1.0.2"
 google-material = "1.4.0"
 
 groovy = "3.0.9"
@@ -137,6 +138,7 @@ androidx-viewbinding = { module = "androidx.databinding:viewbinding", version.re
 dokka-gradle-plugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
 
 google-android-material = { module = "com.google.android.material:material", version.ref = "material" }
+google-ksp = { module = "com.google.devtools.ksp:symbol-processing-gradle-plugin", version.ref = "google-ksp" }
 
 hamcrest = "org.hamcrest:hamcrest-core:2.2"
 

internal-testing-utils/src/main/java/com/squareup/workflow1/internal/util/UncaughtExceptionGuard.kt

@@ -40,7 +40,7 @@ public class UncaughtExceptionGuard {
 
     // If the block completed successfully, but an uncaught exception was reported, report it now.
     uncaughtException.get()
-        ?.let { throw it }
+      ?.let { throw it }
 
     return result
   }

internal-testing-utils/src/test/java/com/squareup/workflow1/internal/util/UncaughtExceptionGuardTest.kt

@@ -47,7 +47,7 @@ class UncaughtExceptionGuardTest {
     try {
       rethrowingUncaughtExceptions {
         Thread.getDefaultUncaughtExceptionHandler()
-            .uncaughtException(Thread.currentThread(), RuntimeException("fail"))
+          .uncaughtException(Thread.currentThread(), RuntimeException("fail"))
       }
       fail("Expected exception.")
     } catch (e: RuntimeException) {
@@ -67,7 +67,7 @@ class UncaughtExceptionGuardTest {
         // Wait for all the other threads are also ready…
         startLatch.await()
         Thread.getDefaultUncaughtExceptionHandler()
-            .uncaughtException(Thread.currentThread(), RuntimeException("fail $i"))
+          .uncaughtException(Thread.currentThread(), RuntimeException("fail $i"))
         finishedLatch.countDown()
       }.start()
     }

samples/compose-samples/src/androidTest/java/com/squareup/sample/compose/hellocompose/HelloComposeTest.kt

@@ -6,8 +6,8 @@ import androidx.compose.ui.test.onNodeWithText
 import androidx.compose.ui.test.performClick
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
+import com.squareup.workflow1.ui.internal.test.DetectLeaksAfterTestSuccess
 import com.squareup.workflow1.ui.internal.test.IdleAfterTestRule
-import leakcanary.DetectLeaksAfterTestSuccess
 import org.junit.Rule
 import org.junit.Test
 import org.junit.rules.RuleChain