IntelliJPlatformGradlePlugin/org.jetbrains.intellij.platform.gradle.tasks/BuildPluginTask

BuildPluginTask

@DisableCachingByDefault(because = "Zip based tasks do not benefit from caching")

abstract class BuildPluginTask : Zip

Builds the plugin and prepares the ZIP archive for testing and deployment.

It takes the output of the PrepareSandboxTask task containing the built project with all its modules and dependencies, and the output of JarSearchableOptionsTask task.

The produced archive is stored in the ProjectLayout.getBuildDirectory/distributions/archiveFile, where the name and location of archiveFile can be controlled with properties provided with the Zip base task. By default, the archiveBaseName is set to the plugin name specified in the plugin.xml file, after it gets patched with the PatchPluginXmlTask task.

Constructors

BuildPluginTask

constructor()

Types

object Companion : Registrable

Properties

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

open val ant: AntBuilder?

archiveAppendix

@get:Internal(value = "Represented as part of archiveFile")

abstract val archiveAppendix: Property<String?>?

archiveBaseName

@get:Internal(value = "Represented as part of archiveFile")

abstract val archiveBaseName: Property<String?>?

archiveClassifier

@get:Internal(value = "Represented as part of archiveFile")

abstract val archiveClassifier: Property<String?>?

archiveExtension

@get:Internal(value = "Represented as part of archiveFile")

abstract val archiveExtension: Property<String?>?

@get:OutputFile

open val archiveFile: Provider<RegularFile?>?

archiveFileName

@get:Internal(value = "Represented as part of archiveFile")

abstract val archiveFileName: Property<String?>?

@get:Internal(value = "Represented as part of archiveFile")

abstract val archiveVersion: Property<String?>?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

conventionMapping

@get:Internal

open val conventionMapping: ConventionMapping?

open val dependsOn: Set<Any?>?

open var description: @Nullable String?

destinationDirectory

@get:Internal(value = "Represented by the archiveFile")

abstract val destinationDirectory: DirectoryProperty?

open val destroyables: TaskDestroyables?

open var didWork: Boolean

@get:Internal

open val dirPermissions: Property<ConfigurableFilePermissions>

duplicatesStrategy

@get:Internal

open var duplicatesStrategy: DuplicatesStrategy

open var enabled: Boolean

entryCompression

@get:Input

open var entryCompression: ZipEntryCompression?

@get:Internal

open val excludes: Set<String>

open val extensions: ExtensionContainer?

filePermissions

@get:Internal

open val filePermissions: Property<ConfigurableFilePermissions>

filteringCharset

@get:Internal

open var filteringCharset: String

open val finalizedBy: TaskDependency?

open var group: @Nullable String?

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

includeEmptyDirs

@get:Internal

open var includeEmptyDirs: Boolean

@get:Internal

open val includes: Set<String>

open val inputs: TaskInputsInternal?

isCaseSensitive

@get:Internal

open var isCaseSensitive: Boolean

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

isPreserveFileTimestamps

@get:Input

open var isPreserveFileTimestamps: Boolean

isReproducibleFileOrder

@get:Input

open var isReproducibleFileOrder: Boolean

@get:Input

open var isZip64: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

open val localState: TaskLocalState?

open val logger: Logger?

open val logging: LoggingManager?

metadataCharset

@get:Optional

@get:Input

open var metadataCharset: @Nullable String?

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?

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

open val rootSpec: CopySpecInternal

sharedResources

open val sharedResources: List<ResourceLock?>?

open val shouldRunAfter: TaskDependency?

@get:Internal

open val source: FileCollection

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?

conventionMapping

open fun conventionMapping(property: String?, mapping: Closure<*>?): Task?

open fun conventionMapping(property: String?, mapping: Callable<*>?): Task?

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

open fun dirPermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

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 eachFile(closure: Closure<*>): AbstractCopyTask

open fun eachFile(action: Action<in FileCopyDetails>): AbstractCopyTask

open fun exclude(excludeSpec: Closure<*>): AbstractCopyTask

open fun exclude(excludes: Iterable<String>): AbstractCopyTask

open fun exclude(excludeSpec: Spec<FileTreeElement>): AbstractCopyTask

open fun exclude(vararg excludes: String): AbstractCopyTask

open fun expand(properties: Map<String, *>): AbstractCopyTask

open fun expand(properties: Map<String, *>, action: Action<in ExpandDetails>): AbstractCopyTask

filePermissions

open fun filePermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

open fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

open fun filesMatching(patterns: Iterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

filesNotMatching

open fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

open fun filesNotMatching(patterns: Iterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

open fun filter(closure: Closure<*>): AbstractCopyTask

open fun filter(filterType: Class<out FilterReader>): AbstractCopyTask

open fun filter(transformer: Transformer<@Nullable String?, String>): AbstractCopyTask

open fun filter(properties: Map<String, *>, filterType: Class<out FilterReader>): AbstractCopyTask

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

open fun from(vararg sourcePaths: @Nullable Any?): AbstractCopyTask

open fun from(sourcePath: Any, c: Closure<*>): AbstractCopyTask

open fun from(sourcePath: Any, configureAction: Action<in CopySpec>): AbstractCopyTask

open fun hasProperty(propertyName: String?): Boolean

open fun hasTaskActions(): Boolean

open fun include(includeSpec: Closure<*>): AbstractCopyTask

open fun include(includes: Iterable<String>): AbstractCopyTask

open fun include(includeSpec: Spec<FileTreeElement>): AbstractCopyTask

open fun include(vararg includes: String): AbstractCopyTask

open fun into(destPath: Any): AbstractArchiveTask

open fun into(destPath: Any, configureClosure: Closure<*>): AbstractArchiveTask

open fun into(destPath: Any, copySpec: Action<in CopySpec>): CopySpec

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 rename(closure: Closure<*>): AbstractCopyTask

open fun rename(renamer: Transformer<@Nullable String?, String>): AbstractCopyTask

open fun rename(sourceRegEx: Pattern, replaceWith: String): AbstractCopyTask

open fun rename(sourceRegEx: String, replaceWith: String): AbstractCopyTask

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

restoreTaskActions

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

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

open fun setExcludes(excludes: Iterable<String>): AbstractCopyTask

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

open fun setIncludes(includes: Iterable<String>): AbstractCopyTask

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?

useFileSystemPermissions

open fun useFileSystemPermissions()

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

open fun with(vararg sourceSpecs: CopySpec): CopySpec