foundry-gradle-plugin/foundry.gradle.tasks/CoreBootstrapTask

CoreBootstrapTask

@UntrackedTask(because = "This should always reset the current state when run.")

abstract class CoreBootstrapTask @Inject constructor(objects: ObjectFactory, providers: ProviderFactory) : DefaultTask(source)

The core Bootstrap task that all bootstrap-applicable tasks can depend on. This task configures the local or CI developer environment for optimal gradle execution.

Constructors

CoreBootstrapTask

@Inject

constructor(objects: ObjectFactory, providers: ProviderFactory)

Types

Companion

object Companion

Properties

object Properties

Properties

bootstrapVersion

@get:Input

abstract val bootstrapVersion: Property<Int>

bootstrapVersionFileProperty

@get:OutputFile

abstract val bootstrapVersionFileProperty: RegularFileProperty

cacheDir

@get:OutputDirectory

abstract val cacheDir: DirectoryProperty

ciBooleanProperty

@get:Input

abstract val ciBooleanProperty: Property<Boolean>

Environments can have different constraints, namely CI vs local.

customCoreMultiplier

@get:Optional

@get:Input

val customCoreMultiplier: Property<String>

Optional custom core multiplier. This should be a number from 1 -> 100 and is a percentage.

customMemoryMultiplier

@get:Optional

@get:Input

val customMemoryMultiplier: Property<String>

Optional custom memory multiplier. This should be a number from 1 -> 100 and is a percentage.

diagnostics

@get:OutputFile

abstract val diagnostics: RegularFileProperty

enabled

@get:Internal

var enabled: Boolean

extraJvmArgs

@get:Input

val extraJvmArgs: ListProperty<String>

garbageCollector

@get:Optional

@get:Input

val garbageCollector: Property<String>

Optional custom garbage collector to use. Note that this is just for testing and will be removed.

gradleMemoryPercentage

@get:Optional

@get:Input

val gradleMemoryPercentage: Property<String>

Optional custom Gradle memory multiplier. This should be a number from 1 -> 100 and is a percentage.

gradlePropertiesFile

@get:PathSensitive(value = PathSensitivity.ABSOLUTE)

@get:InputFile

abstract val gradlePropertiesFile: RegularFileProperty

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

javaInstallationPath

@get:OutputFile

abstract val javaInstallationPath: RegularFileProperty

Output file of the java installation, useful for CI to point JAVA_HOME at it.

jdkDocsLink

@get:Optional

@get:Input

abstract val jdkDocsLink: Property<String>

jdkVersion

@get:Optional

@get:Input

abstract val jdkVersion: Property<Int>

If using java toolchains, this is specified to indicate the requested JDK version.

launcher

@get:Optional

abstract val launcher: Property<JavaLauncher>

We require a launcher here and query it so we can let Gradle handle downloading and installation of the appropriate JDKs.

minGradleXms

@get:Optional

@get:Input

val minGradleXms: Property<Int>

Optional override for max gradle daemon xmx. This should an integer >= 0.

minGradleXmx

@get:Optional

@get:Input

val minGradleXmx: Property<Int>

Optional override for min gradle daemon xmx. This should an integer >= 0.

offlineBooleanProperty

@get:Input

abstract val offlineBooleanProperty: Property<Boolean>

propertiesMode

@get:Input

abstract val propertiesMode: Property<BootstrapPropertiesMode>

Controls how properties are handled.

state

val state: TaskStateInternal

timeout

val timeout: Property<Duration>

Functions

acceptServiceReferences

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

appendParallelSafeAction

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

compareTo

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

configure

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

dependsOn

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

doFirst

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

doLast

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)

finalizedBy

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

getActions

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

getAnt

open override fun getAnt(): AntBuilder

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

getDependsOn

open override fun getDependsOn(): MutableSet<Any>

getDescription

open override fun getDescription(): String?

getDestroyables

open override fun getDestroyables(): TaskDestroyables

getDidWork

open override fun getDidWork(): Boolean

getExtensions

open override fun getExtensions(): ExtensionContainer

getFinalizedBy

open override fun getFinalizedBy(): TaskDependency

getGroup

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

getInputs

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

getLocalState

open override fun getLocalState(): TaskLocalState

getLogger

open override fun getLogger(): Logger

getLogging

open override fun getLogging(): LoggingManager

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

getName

open override fun getName(): String

getOnlyIf

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

getOutputs

open override fun getOutputs(): TaskOutputsInternal

getPath

open override fun getPath(): String

getProject

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<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

getTaskActions

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>

hasProperty

open override fun hasProperty(propertyName: String): Boolean

hasTaskActions

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

mustRunAfter

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

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

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>)

property

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

setActions

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

setDependsOn

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

setDescription

open override fun setDescription(description: String?)

setDidWork

open override fun setDidWork(didWork: Boolean)

setFinalizedBy

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

setGroup

open override fun setGroup(group: String?)

setMustRunAfter

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

setOnlyIf

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>)

setProperty

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

setShouldRunAfter

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

shouldRunAfter

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

usesService

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