feat: new dependencyAnalysis.reporting.printBuildHealth DSL option.

Author: autonomousapps

src/main/kotlin/com/autonomousapps/Flags.kt

@@ -35,7 +35,13 @@ object Flags {
 
   internal fun Project.shouldAnalyzeTests() = getGradleOrSysProp(FLAG_TEST_ANALYSIS, true)
 
+  /**
+   * Whether to print the buildHealth report to console.
+   *
+   * @see [com.autonomousapps.extension.ReportingHandler.printBuildHealth]
+   */
   internal fun Project.printBuildHealth() = getGradlePropForConfiguration(FLAG_PRINT_BUILD_HEALTH, false)
+
   internal fun Project.androidIgnoredVariants() = getGradlePropForConfiguration(
     FLAG_ANDROID_IGNORED_VARIANTS, ""
   ).split(",")

src/main/kotlin/com/autonomousapps/extension/ReportingHandler.kt

@@ -14,7 +14,10 @@ import javax.inject.Inject
  * dependencyAnalysis {
  *   reporting {
  *     onlyOnFailure(false) // when true, only prints postscript when there are failure-level issues.
+ *
  *     postscript(/* Some text to help out end users who may not be build engineers. */)
+ *
+ *     printBuildHealth(false) // when true, prints buildHealth report to console
  *   }
  * }
  * ```
@@ -24,6 +27,10 @@ abstract class ReportingHandler @Inject constructor(private val objects: ObjectF
   internal val onlyOnFailure: Property<Boolean> = objects.property<Boolean>().convention(false)
   internal val postscript: Property<String> = objects.property<String>().convention("")
 
+  // nb: this intentionally does not have a convention set. If the user does not supply a value, we then check the
+  // value of the Gradle property, which itself supplies a default value.
+  internal val printBuildHealth: Property<Boolean> = objects.property<Boolean>()
+
   /**
    * Whether to always include the postscript, or only when the report includes failure-level issues.
    */
@@ -40,6 +47,16 @@ abstract class ReportingHandler @Inject constructor(private val objects: ObjectF
     this.postscript.disallowChanges()
   }
 
+  /**
+   * Whether to print the buildHealth report to console.
+   *
+   * @see [com.autonomousapps.Flags.FLAG_PRINT_BUILD_HEALTH]
+   */
+  fun printBuildHealth(printBuildHealth: Boolean) {
+    this.printBuildHealth.set(printBuildHealth)
+    this.printBuildHealth.disallowChanges()
+  }
+
   internal fun config(): Config {
     val config = objects.newInstance<Config>()
     config.onlyOnFailure.set(onlyOnFailure)

src/main/kotlin/com/autonomousapps/subplugin/RootPlugin.kt

@@ -127,7 +127,7 @@ internal class RootPlugin(private val project: Project) {
       shouldFail.set(generateBuildHealthTask.flatMap { it.outputFail })
       buildHealth.set(generateBuildHealthTask.flatMap { it.output })
       consoleReport.set(generateBuildHealthTask.flatMap { it.consoleOutput })
-      printBuildHealth.set(printBuildHealth())
+      printBuildHealth.set(dagpExtension.reportingHandler.printBuildHealth.orElse(printBuildHealth()))
       postscript.set(dagpExtension.reportingHandler.postscript)
     }