KiteConfig/io.github.yuroyami.kiteconfig/KiteConfigPlanTask

KiteConfigPlanTask

@DisableCachingByDefault(because = "Reports current filesystem state and is intentionally always run.")

abstract class KiteConfigPlanTask : DefaultTask

Read-only report of the source-tree mutations the current configuration authorizes.

Central wiring supplies the stable operation names, the selected targets, and the effective safety policies. It also supplies the configured mutation roots, together with the deterministic backup, ownership, recovery, and coordination paths derived from them.

A directory entry can hold dynamically discovered Swift files. exactChanges exposes the available summaries without running an installer.

The four read-only tasks

Task	Answers	Fails the build
`kiteVerify`	which values did KiteConfig resolve?	no
`kiteDoctor`	what is wrong with my setup?	no
`kiteCheck`	the same, for CI	yes, on ERROR findings
`kitePlan`	what would the mutation tasks write?	no

None of the four writes to your source tree, and none of them needs dryRun. Colour is added when a real terminal is attached; NO_COLOR, TERM=dumb, and --console=plain each turn it off, and -Pkiteconfig.color=true|false forces it.

Constructors

KiteConfigPlanTask

constructor()

Properties

@get:Internal

abstract val colorEnabled: Property<Boolean>

Presentation only, so it never affects up-to-date checks.

var description: @Nullable String

@get:Internal

var enabled: Boolean

@get:Internal

abstract val exactChanges: ListProperty<String>

var group: @Nullable String

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

@get:Internal

abstract val mutationPaths: ListProperty<String>

@get:Internal

abstract val notes: ListProperty<String>

@get:Internal

abstract val operations: ListProperty<String>

@get:Internal

abstract val policies: MapProperty<String, String>

@get:Internal

abstract val projectRootDir: DirectoryProperty

selectedTargets

@get:Internal

abstract val selectedTargets: ListProperty<String>

val state: TaskStateInternal

val timeout: Property<Duration>

Functions

acceptServiceReferences

open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)

appendParallelSafeAction

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

open operator override fun compareTo(other: Task): Int

open override fun configure(closure: Closure<Any>): Task

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

open override fun doFirst(action: Closure<Any>): Task

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

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

open override fun doLast(action: Closure<Any>): Task

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

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

doNotTrackState

open override fun doNotTrackState(reasonNotToTrackState: String)

doNotTrackStateIf

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

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

open override fun getActions(): MutableList<Action<in Task>>

open override fun getAnt(): AntBuilder

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

open override fun getDependsOn(): MutableSet<Any>

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

open override fun getExtensions(): ExtensionContainer

open override fun getFinalizedBy(): TaskDependency

getIdentityPath

open override fun getIdentityPath(): Path

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

open override fun getLocalState(): TaskLocalState

open override fun getLogger(): Logger

open override fun getLogging(): LoggingManager

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

open override fun getName(): String

open override fun getOnlyIf(): Spec<in TaskInternal>

open override fun getOutputs(): TaskOutputsInternal

open override fun getPath(): String

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonsNotToTrackState

open override fun getReasonsNotToTrackState(): MutableSet<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): TaskRequiredServices

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

open override fun hasProperty(propertyName: String): Boolean

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

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

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

open override fun onlyIf(onlyIfClosure: Closure<Any>)

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

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

prependParallelSafeAction

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

open override fun property(propertyName: String): Any

fun report()

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

restoreTaskActions

open override fun restoreTaskActions(taskActions: MutableList<InputChangesAwareTaskAction>)

open override fun setActions(replacements: MutableList<Action<in Task>>)

open override fun setDependsOn(dependsOn: MutableIterable<*>)

open override fun setDidWork(didWork: Boolean)

open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)

setMustRunAfter

open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)

open override fun setOnlyIf(onlyIfClosure: Closure<Any>)

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

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

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

setShouldRunAfter

open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)

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

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