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

archiveAppendix

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

val archiveAppendix: Property<String>

archiveBaseName

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

val archiveBaseName: Property<String>

archiveClassifier

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

val archiveClassifier: Property<String>

archiveExtension

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

val archiveExtension: Property<String>

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

val archiveVersion: Property<String>

conventionMapping

@get:Internal

val conventionMapping: ConventionMapping

@get:Internal

var enabled: Boolean

entryCompression

@get:Input

var entryCompression: ZipEntryCompression

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

@get:Internal

val rootSpec: CopySpecInternal

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

conventionMapping

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

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

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

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

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)

open override fun eachFile(closure: Closure<Any>): AbstractCopyTask

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

open override fun exclude(excludeSpec: Closure<Any>): AbstractCopyTask

open override fun exclude(vararg excludes: String): AbstractCopyTask

open override fun exclude(excludes: MutableIterable<String>): AbstractCopyTask

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

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

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

filePermissions

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

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

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

filesNotMatching

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

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

open override fun filter(closure: Closure<Any>): AbstractCopyTask

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

open override fun filter(transformer: Transformer<String, String>): AbstractCopyTask

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

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

open override fun from(vararg sourcePaths: Any): AbstractCopyTask

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

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

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

open override fun getAnt(): AntBuilder

@OutputFile

open fun getArchiveFile(): Provider<RegularFile>

getArchiveFileName

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

open fun getArchiveFileName(): Property<String>

@ReplacedBy(value = "archiveFile")

open fun ~~getArchivePath~~(): File

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

@Internal

open override fun ~~getConvention~~(): Convention

open override fun getDependsOn(): MutableSet<Any>

open override fun getDescription(): String?

getDestinationDirectory

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

open fun getDestinationDirectory(): DirectoryProperty

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

@Internal

open override fun ~~getDirMode~~(): Int?

getDirPermissions

@Internal

open override fun getDirPermissions(): Property<ConfigurableFilePermissions>

getDuplicatesStrategy

@Internal

open override fun getDuplicatesStrategy(): DuplicatesStrategy

@Internal

open override fun getExcludes(): MutableSet<String>

open override fun getExtensions(): ExtensionContainer

@Internal

open override fun ~~getFileMode~~(): Int?

getFilePermissions

@Internal

open override fun getFilePermissions(): Property<ConfigurableFilePermissions>

getFilteringCharset

@Internal

open override fun getFilteringCharset(): String

open override fun getFinalizedBy(): TaskDependency

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

getIncludeEmptyDirs

@Internal

open override fun getIncludeEmptyDirs(): Boolean

@Internal

open override fun getIncludes(): MutableSet<String>

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

getMetadataCharset

@Optional

@Input

open fun getMetadataCharset(): String?

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>

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

@Internal

open fun getSource(): FileCollection

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

open override fun include(includeSpec: Closure<Any>): AbstractCopyTask

open override fun include(vararg includes: String): AbstractCopyTask

open override fun include(includes: MutableIterable<String>): AbstractCopyTask

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

open override fun into(destPath: Any): AbstractArchiveTask

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

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

isCaseSensitive

@Internal

open override fun isCaseSensitive(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

isPreserveFileTimestamps

@Input

open fun isPreserveFileTimestamps(): Boolean

isReproducibleFileOrder

@Input

open fun isReproducibleFileOrder(): Boolean

@Input

open fun isZip64(): 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?

open override fun rename(closure: Closure<Any>): AbstractCopyTask

open override fun rename(renamer: Transformer<String, String>): AbstractCopyTask

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

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

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

setCaseSensitive

open override fun setCaseSensitive(caseSensitive: Boolean)

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

open override fun setDescription(description: String?)

open override fun setDidWork(didWork: Boolean)

open override fun ~~setDirMode~~(@Nullable mode: Int?): AbstractCopyTask

setDuplicatesStrategy

open override fun setDuplicatesStrategy(strategy: DuplicatesStrategy)

open override fun setExcludes(excludes: MutableIterable<String>): AbstractCopyTask

open override fun ~~setFileMode~~(@Nullable mode: Int?): AbstractCopyTask

setFilteringCharset

open override fun setFilteringCharset(charset: String)

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

open override fun setGroup(group: String?)

setIncludeEmptyDirs

open override fun setIncludeEmptyDirs(includeEmptyDirs: Boolean)

open override fun setIncludes(includes: MutableIterable<String>): AbstractCopyTask

setMetadataCharset

open fun setMetadataCharset(metadataCharset: String)

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

setPreserveFileTimestamps

open fun setPreserveFileTimestamps(preserveFileTimestamps: Boolean)

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

setReproducibleFileOrder

open fun setReproducibleFileOrder(reproducibleFileOrder: Boolean)

setShouldRunAfter

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

open fun setZip64(allowZip64: Boolean)

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

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

open override fun with(vararg sourceSpecs: CopySpec): CopySpec