kotlin-library-api-watchdog-gradle-plugin/org.jetbrains.kotlinx.libs.api.watchdog/UpdateBackwardsCompatibilityExemptsTask

UpdateBackwardsCompatibilityExemptsTask

@UntrackedTask(because = "Rewrites the Kotlin sources it analyzes, so it must always run")

abstract class UpdateBackwardsCompatibilityExemptsTask : DefaultTask(source)

Rewrites the module's Kotlin sources so that every recorded watchdog diagnostic is acknowledged with the matching @Intentionally* exemption annotation carrying reason = ExemptionReason.FOR_BACKWARDS_COMPATIBILITY.

The task is meant for adopting the watchdog on an existing library: the already-shipped API can't change shape without breaking users, so its diagnostics are acknowledged wholesale and the checks keep guarding only the API added afterwards. New code should get a deliberate decision instead: fix the shape, or pick the honest reason by hand.

When this task is selected, every main Kotlin compilation writes a report through the regular KGP compile task. This task depends on those compilations, hands all reports to one standalone PSI fixer process, and never invokes a Kotlin compiler itself. Exact duplicates from common sources compiled for several targets are removed by the fixer.

Constructors

UpdateBackwardsCompatibilityExemptsTask

constructor()

Properties

open var actions: List<Action<in Task?>?>?

open val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

compilationNames

@get:Input

abstract val compilationNames: ListProperty<String>

The main Kotlin compile task names KGP exposed to the compiler support plugin.

open val dependsOn: Set<Any?>?

open var description: @Nullable String?

open val destroyables: TaskDestroyables?

diagnosticReports

@get:Internal

abstract val diagnosticReports: ConfigurableFileCollection

Reports written by the regular Kotlin compilation tasks. Missing reports are empty.

open var didWork: Boolean

open var enabled: Boolean

@get:Inject

protected abstract val execOperations: ExecOperations

open val extensions: ExtensionContainer?

open val finalizedBy: TaskDependency?

@get:Classpath

abstract val fixerClasspath: ConfigurableFileCollection

The standalone fixer tool and kotlin-compiler-embeddable used for PSI parsing.

open var group: @Nullable String?

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

open val localState: TaskLocalState?

open val logger: Logger?

open val logging: LoggingManager?

open val mustRunAfter: TaskDependency?

open val name: String?

open val onlyIf: Spec<in TaskInternal?>?

open val outputs: TaskOutputsInternal?

open val path: String?

open val project: Project?

projectDirectory

@get:Internal

abstract val projectDirectory: DirectoryProperty

The directory console output relativizes source paths against.

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

@get:Internal

protected open val services: ServiceRegistry?

sharedResources

open val sharedResources: List<ResourceLock?>?

open val shouldRunAfter: TaskDependency?

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

open val state: TaskStateInternal?

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

open val taskIdentity: TaskIdentity<*>?

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

open val timeout: Property<Duration?>?

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

open operator fun compareTo(otherTask: Task?): Int

open fun configure(closure: Closure<*>?): Task?

open fun dependsOn(vararg paths: Any?): Task?

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

open fun finalizedBy(vararg paths: Any?): Task?

open fun hasProperty(propertyName: String?): Boolean

open fun hasTaskActions(): Boolean

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

open fun onlyIf(onlyIfClosure: Closure<*>?)

open fun onlyIf(spec: Spec<in Task?>?)

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task?>?)

open fun property(propertyName: String?): Any?

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

open fun setDependsOn(dependsOn: Iterable<*>?)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

open fun setOnlyIf(spec: Spec<in Task?>?)

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

open fun setProperty(name: String?, value: Any?)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

fun updateExempts()

open fun usesService(service: Provider<out BuildService<*>?>?)