Merge pull request #819 from square/rick/publish_convention

RBusarow · web-flow · commit 0d813177b752 · 2022-06-23T14:00:21.000-05:00
add a `published` convention plugin and enforce `-SNAPSHOT` versions in CI
diff --git a/.buildscript/configure-maven-publish.gradle b/.buildscript/configure-maven-publish.gradle
diff --git a/.github/workflows/kotlin.yml b/.github/workflows/kotlin.yml
@@ -80,7 +80,7 @@ jobs :
           gradle-dependencies-cache-key : |
             gradle/libs.versions.toml
           arguments : |
-            check apiCheck artifactsCheck dependencyGuard lint ktlintCheck jvmWorkflowNodeBenchmarkJar --no-daemon --stacktrace --continue
+            check apiCheck checkVersionIsSnapshot artifactsCheck dependencyGuard lint ktlintCheck jvmWorkflowNodeBenchmarkJar --no-daemon --stacktrace --continue
           concurrent : true
           gradle-build-scan-report : false
           gradle-distribution-sha-256-sum-warning : false
diff --git a/.github/workflows/publish-snapshot.yml b/.github/workflows/publish-snapshot.yml
@@ -22,6 +22,9 @@ jobs:
           distribution: 'zulu'
           java-version: 11
 
+      - name : Check for -SNAPSHOT version
+        run: ./gradlew checkVersionIsSnapshot --no-daemon
+
       - name : Publish Snapshots
         run: |
           ./gradlew clean build --no-daemon
diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -16,10 +16,12 @@ dependencies {
   compileOnly(gradleApi())
 
   implementation(libs.android.gradle.plugin)
+  implementation(libs.dokka.gradle.plugin)
   implementation(libs.dropbox.dependencyGuard)
   implementation(libs.kotlin.gradle.plugin)
   implementation(libs.squareup.moshi)
   implementation(libs.squareup.moshi.adapters)
+  implementation(libs.vanniktech.publish)
 
   ksp(libs.squareup.moshi.codegen)
 }
diff --git a/buildSrc/src/main/java/published.gradle.kts b/buildSrc/src/main/java/published.gradle.kts
@@ -0,0 +1,28 @@
+import com.android.build.gradle.TestedExtension
+import com.squareup.workflow1.library
+import com.squareup.workflow1.libsCatalog
+import com.vanniktech.maven.publish.SonatypeHost
+
+plugins {
+  id("org.jetbrains.dokka")
+  id("com.vanniktech.maven.publish")
+  // track all runtime classpath dependencies for anything we ship
+  id("dependency-guard")
+}
+
+group = project.property("GROUP") as String
+version = project.property("VERSION_NAME") as String
+
+mavenPublish {
+  sonatypeHost = SonatypeHost.S01
+}
+
+tasks.register("checkVersionIsSnapshot") {
+  doLast {
+    val expected = "-SNAPSHOT"
+    require((version as String).endsWith(expected)) {
+      "The project's version name must be suffixed with `$expected` when checked in" +
+        " to the main branch, but instead it's `$version`."
+    }
+  }
+}
diff --git a/internal-testing-utils/build.gradle.kts b/internal-testing-utils/build.gradle.kts
@@ -1,9 +1,8 @@
 plugins {
   `kotlin-jvm`
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   implementation(libs.kotlin.jdk8)
 
diff --git a/trace-encoder/build.gradle.kts b/trace-encoder/build.gradle.kts
@@ -1,11 +1,9 @@
 plugins {
   `kotlin-jvm`
   id("com.google.devtools.ksp")
-  id("com.vanniktech.maven.publish")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   compileOnly(libs.jetbrains.annotations)
   compileOnly(libs.squareup.moshi.codegen)
diff --git a/workflow-config/config-android/build.gradle.kts b/workflow-config/config-android/build.gradle.kts
@@ -2,7 +2,7 @@ plugins {
   id("com.android.library")
   `kotlin-android`
   `android-defaults`
-  id("org.jetbrains.dokka")
+  published
 }
 
 android {
@@ -16,8 +16,6 @@ android {
   }
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   api(project(":workflow-runtime"))
 }
diff --git a/workflow-config/config-jvm/build.gradle.kts b/workflow-config/config-jvm/build.gradle.kts
@@ -1,7 +1,7 @@
 plugins {
   `java-library`
   `kotlin-jvm`
-  id("org.jetbrains.dokka")
+  published
 }
 
 tasks.withType<Test> {
@@ -18,8 +18,6 @@ tasks.withType<Test> {
     }
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   api(project(":workflow-runtime"))
 }
diff --git a/workflow-core/build.gradle.kts b/workflow-core/build.gradle.kts
@@ -1,10 +1,8 @@
 plugins {
   `kotlin-multiplatform`
-  id("org.jetbrains.dokka")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 kotlin {
   jvm { withJava() }
   ios()
diff --git a/workflow-runtime/build.gradle.kts b/workflow-runtime/build.gradle.kts
@@ -3,12 +3,10 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
   `kotlin-multiplatform`
-  id("org.jetbrains.dokka")
+  published
   id("org.jetbrains.kotlinx.benchmark")
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 kotlin {
   jvm {
     compilations {
diff --git a/workflow-rx2/build.gradle.kts b/workflow-rx2/build.gradle.kts
@@ -1,10 +1,8 @@
 plugins {
   `kotlin-jvm`
-  id("org.jetbrains.dokka")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   compileOnly(libs.jetbrains.annotations)
 
diff --git a/workflow-testing/build.gradle.kts b/workflow-testing/build.gradle.kts
@@ -3,7 +3,7 @@
 plugins {
   `java-library`
   `kotlin-jvm`
-  id("org.jetbrains.dokka")
+  published
 }
 
 tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
@@ -20,8 +20,6 @@ tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
   }
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   compileOnly(libs.jetbrains.annotations)
 
diff --git a/workflow-tracing/build.gradle.kts b/workflow-tracing/build.gradle.kts
@@ -1,10 +1,8 @@
 plugins {
   `kotlin-jvm`
-  id("com.vanniktech.maven.publish")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   compileOnly(libs.jetbrains.annotations)
 
diff --git a/workflow-ui/compose-tooling/build.gradle.kts b/workflow-ui/compose-tooling/build.gradle.kts
@@ -5,11 +5,9 @@ plugins {
   `kotlin-android`
   `android-defaults`
   `android-ui-tests`
-  id("org.jetbrains.dokka")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 android {
   buildFeatures.compose = true
   composeOptions {
diff --git a/workflow-ui/compose/build.gradle.kts b/workflow-ui/compose/build.gradle.kts
@@ -5,11 +5,9 @@ plugins {
   `kotlin-android`
   `android-defaults`
   `android-ui-tests`
-  id("org.jetbrains.dokka")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 android {
   buildFeatures.compose = true
   composeOptions {
diff --git a/workflow-ui/container-android/build.gradle.kts b/workflow-ui/container-android/build.gradle.kts
@@ -3,11 +3,9 @@ plugins {
   `kotlin-android`
   `android-defaults`
   `android-ui-tests`
-  id("org.jetbrains.dokka")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   api(project(":workflow-core"))
   api(project(":workflow-ui:core-android"))
diff --git a/workflow-ui/container-common/build.gradle.kts b/workflow-ui/container-common/build.gradle.kts
@@ -1,10 +1,8 @@
 plugins {
   `kotlin-jvm`
-  id("org.jetbrains.dokka")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   api(project(":workflow-ui:core-common"))
   api(libs.kotlin.jdk6)
diff --git a/workflow-ui/core-android/build.gradle.kts b/workflow-ui/core-android/build.gradle.kts
@@ -3,11 +3,9 @@ plugins {
   `kotlin-android`
   `android-defaults`
   `android-ui-tests`
-  id("org.jetbrains.dokka")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   compileOnly(libs.androidx.viewbinding)
 
diff --git a/workflow-ui/core-common/build.gradle.kts b/workflow-ui/core-common/build.gradle.kts
@@ -1,10 +1,8 @@
 plugins {
   `kotlin-jvm`
-  id("org.jetbrains.dokka")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 dependencies {
   api(libs.kotlin.jdk6)
   api(libs.squareup.okio)
diff --git a/workflow-ui/radiography/build.gradle.kts b/workflow-ui/radiography/build.gradle.kts
@@ -3,11 +3,9 @@ plugins {
   `kotlin-android`
   `android-defaults`
   `android-ui-tests`
-  id("org.jetbrains.dokka")
+  published
 }
 
-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))
-
 android {
   // See https://github.com/Kotlin/kotlinx.coroutines/issues/1064#issuecomment-479412940
   packagingOptions.exclude("**/*.kotlin_*")

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,8 @@`
`1`	`1`	`plugins {`
`2`	`2`	`kotlin-jvm`
	`3`	`+ published`
`3`	`4`	`}`
`4`	`5`
`5`		`-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))`
`6`		`-`
`7`	`6`	`dependencies {`
`8`	`7`	`implementation(libs.kotlin.jdk8)`
`9`	`8`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ plugins {`
`2`	`2`	`id("com.android.library")`
`3`	`3`	`kotlin-android`
`4`	`4`	`android-defaults`
`5`		`- id("org.jetbrains.dokka")`
	`5`	`+ published`
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`android {`
`@@ -16,8 +16,6 @@ android {`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`
`19`		`-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))`
`20`		`-`
`21`	`19`	`dependencies {`
`22`	`20`	`api(project(":workflow-runtime"))`
`23`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`plugins {`
`2`	`2`	`java-library`
`3`	`3`	`kotlin-jvm`
`4`		`- id("org.jetbrains.dokka")`
	`4`	`+ published`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`tasks.withType<Test> {`
`@@ -18,8 +18,6 @@ tasks.withType<Test> {`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`
`21`		`-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))`
`22`		`-`
`23`	`21`	`dependencies {`
`24`	`22`	`api(project(":workflow-runtime"))`
`25`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`plugins {`
`4`	`4`	`java-library`
`5`	`5`	`kotlin-jvm`
`6`		`- id("org.jetbrains.dokka")`
	`6`	`+ published`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {`
`@@ -20,8 +20,6 @@ tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {`
`20`	`20`	`}`
`21`	`21`	`}`
`22`	`22`
`23`		`-apply(from = rootProject.file(".buildscript/configure-maven-publish.gradle"))`
`24`		`-`
`25`	`23`	`dependencies {`
`26`	`24`	`compileOnly(libs.jetbrains.annotations)`
`27`	`25`