fun CheckResult.assertBinaryCompatible() {
        assertTrue(richReport.toAssertionMessage("Expected to be compatible but the check failed"), isBinaryCompatible)
    }

    private
    fun CheckResult.assertNotBinaryCompatible() {
        assertFalse(richReport.toAssertionMessage("Expected to be breaking but the check passed"), isBinaryCompatible)
    }

    private
    fun RichReport.toAssertionMessage(message: String) =

## Project structure

Mostly a standard Maven project structure. The entry point `settings.kts` defines the TeamCity project.

There are 3 subprojects in the TeamCity project hierarchy: `Check` for Gradle builds, `Promotion` for releasing Gradle versions, `Util` for miscellaneous utilities.

## Develop and verify

        name = "Nightly Snapshot (from QuickFeedback) - Promote"
        description = "Promotes a previously built distribution on this agent on '${branch.branchName}' from Quick Feedback as a new nightly snapshot. This build checks out gradle-promote, so don't be misled by the 'master' branch."

        steps {
            buildStep(
                ******@****.***arameters,

 */

package gradlebuild.binarycompatibility

import org.gradle.api.GradleException
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.TaskAction


/**
 * This [Task][org.gradle.api.Task] checks that the contents of a given accepted API changes file
 * are present in alphabetical order (by type, then member), and throws an exception and reports
 * any changes that are not.
 */
@CacheableTask

    val functionFqName = "$qualifiedBaseName.${method.name}"

    return collectDescendantsOfType { ktFunction ->
        // Name check
        if (ktFunction.fqName?.asString() != functionFqName) {
            return@collectDescendantsOfType false
        }

        // Preliminary extension function check
        val extensionCandidate = couldBeExtensionFunction && ktFunction.receiverTypeReference != null &&

            listOf(
                "clean",
                "performance:${testProject}PerformanceAdHocTest",
                tests.map { """--tests "$it"""" }.joinToString(" "),
                """--warmups 2 --runs 2 --checks none""",
                "-PtestJavaVersion=${os.perfTestJavaVersion.major}",
                "-PtestJavaVendor=${os.perfTestJavaVendor}",
                "-PautoDownloadAndroidStudio=true",

            description = "Additional options for the test task to run (`-PrerunAllTests` is already added implicitly)"
        )
    }

    dependencies {
        compileAllDependency(CompileAll.buildTypeId("Check"))
    }

            param("env.LC_ALL", "en_US.UTF-8")
        }
    }
}

fun BuildSteps.checkCleanM2AndAndroidUserHome(os: Os = Os.LINUX, buildType: BuildType? = null) {
    script {
        name = "CHECK_CLEAN_M2_ANDROID_USER_HOME"
        executionMode = BuildStep.ExecutionMode.ALWAYS
        scriptContent = if (os == Os.WINDOWS) {
            checkCleanDirWindows("%teamcity.agent.jvm.user.home%\\.m2\\repository") +

    // DISCUSS
    "EqualsGetClass", // Let's agree if we want to adopt Error Prone's idea of valid equals()
    "JdkObsolete", // Most of the checks are good, but we do not want to replace all LinkedLists without a good reason

    // NEVER
    "MissingSummary", // We have another mechanism to check Javadocs on public API
    "InjectOnConstructorOfAbstractClass", // We use abstract injection as a pattern

    vcsRootId = gradlePromotionBranches,
    cleanCheckout = false
) {
    init {
        id("Promotion_SnapshotFromQuickFeedbackStepCheckReady")
        name = "Nightly Snapshot (from QuickFeedback) - Check Ready"
        description = "Checks that a nightly snapshot can be published from QuickFeedback"
    }