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

SignPluginTask

@CacheableTask

abstract class SignPluginTask : JavaExec, SigningAware

Signs the ZIP archive with the provided key using the Marketplace ZIP Signer library.

To sign the plugin before publishing to JetBrains Marketplace with the SignPluginTask task, it is required to provide a certificate chain and a private key with its password using IntelliJPlatformExtension.Signing extension.

As soon as privateKey (or privateKeyFile) and certificateChain (or certificateChainFile) properties are specified, the task will be executed automatically right before the PublishPluginTask task.

For more details, see Plugin Signing.

Constructors

constructor()

Types

object Companion : Registrable

Properties

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

open var allJvmArgs: List<String?>?

open val ant: AntBuilder?

@get:InputFile

@get:SkipWhenEmpty

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val archiveFile: RegularFileProperty

Specifies the unsigned ZIP archive input file. Corresponds to the in CLI option.

open var args: List<String?>?

argumentProviders

open val argumentProviders: List<CommandLineArgumentProvider?>?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

bootstrapClasspath

open var bootstrapClasspath: FileCollection?

certificateChain

@get:Input

@get:Optional

abstract val certificateChain: Property<String>

Specifies a string containing X509 certificates. The first certificate in the chain will be used as a certificate authority (CA). This parameter corresponds to the cert CLI option.

certificateChainFile

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val certificateChainFile: RegularFileProperty

Specifies the path to the file containing X509 certificates. The first certificate in the chain will be used as a certificate authority (CA). Corresponds to the cert-file CLI option.

open var classpath: FileCollection?

@get:Internal

open val commandLine: List<String?>?

conventionMapping

@get:Internal

open val conventionMapping: ConventionMapping?

open var debug: Boolean

open val debugOptions: JavaDebugOptions?

defaultCharacterEncoding

open var defaultCharacterEncoding: @Nullable String?

open val dependsOn: Set<Any?>?

open var description: @Nullable String?

open val destroyables: TaskDestroyables?

open var didWork: Boolean

enableAssertions

open var enableAssertions: Boolean

open var enabled: Boolean

@get:Internal

open var environment: Map<String?, Any?>?

@get:Internal

open var errorOutput: OutputStream?

@get:Internal(value = "covered by getJavaVersion")

open var executable: @Nullable String?

executionResult

@get:Internal

open val executionResult: Provider<ExecResult?>?

open val extensions: ExtensionContainer?

open val finalizedBy: TaskDependency?

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

isIgnoreExitValue

@get:Input

open var isIgnoreExitValue: Boolean

abstract val javaLauncher: Property<JavaLauncher?>?

@get:Internal(value = "covered by getJavaLauncher().getMetadata().getLanguageVersion()")

open val javaVersion: JavaVersion?

open var jvmArgs: List<String?>?

jvmArgumentProviders

open val jvmArgumentProviders: List<CommandLineArgumentProvider?>?

open val jvmArguments: ListProperty<String?>?

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val keyStore: RegularFileProperty

Specifies the KeyStore file path. Corresponds to the ks CLI option.

keyStoreKeyAlias

@get:Input

@get:Optional

abstract val keyStoreKeyAlias: Property<String>

Specifies the KeyStore key alias. Corresponds to the ks-key-alias CLI option.

keyStorePassword

@get:Input

@get:Optional

abstract val keyStorePassword: Property<String>

Specifies the KeyStore password. Corresponds to the ks-pass CLI option.

keyStoreProviderName

@get:Input

@get:Optional

abstract val keyStoreProviderName: Property<String>

Specifies the JCA KeyStore Provider name. Corresponds to the ks-provider-name CLI option.

@get:Input

@get:Optional

abstract val keyStoreType: Property<String>

Specifies the KeyStore type. Corresponds to the ks-type CLI option.

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

open val localState: TaskLocalState?

open val logger: Logger?

open val logging: LoggingManager?

abstract val mainClass: Property<String?>?

abstract val mainModule: Property<String?>?

open var maxHeapSize: @Nullable String?

open var minHeapSize: @Nullable String?

open val modularity: ModularitySpec?

open val mustRunAfter: TaskDependency?

open val name: String?

open val onlyIf: Spec<in TaskInternal?>?

open val outputs: TaskOutputsInternal?

@get:Input

@get:Optional

abstract val password: Property<String>

Specifies the password required to decrypt the private key. Corresponds to the key-pass CLI option.

open val path: String?

@get:Input

@get:Optional

abstract val privateKey: Property<String>

Specifies the encoded private key in the PEM format. Corresponds to the key CLI option.

@get:InputFile

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val privateKeyFile: RegularFileProperty

Specifies a file with an encoded private key in the PEM format. Corresponds to the key-file CLI option.

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?

sharedResources

open val sharedResources: List<ResourceLock?>?

open val shouldRunAfter: TaskDependency?

signedArchiveFile

@get:OutputFile

abstract val signedArchiveFile: RegularFileProperty

Specifies the signed ZIP archive output file. Corresponds to the out CLI option.

@get:Internal

open var standardInput: InputStream?

@get:Internal

open var standardOutput: OutputStream?

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

open val state: TaskStateInternal?

systemProperties

open var systemProperties: Map<String?, @Nullable Any?>?

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

@get:Internal

open var workingDir: File?

zipSignerExecutable

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

@get:Optional

abstract val zipSignerExecutable: RegularFileProperty

Path to the Marketplace ZIP Signer executable.

Functions

acceptServiceReferences

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

appendParallelSafeAction

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

open fun args(args: Iterable<*>?): JavaExecSpec?

open fun args(vararg args: Any?): JavaExec?

bootstrapClasspath

open fun bootstrapClasspath(vararg classpath: @Nullable Any?): JavaExec?

open fun classpath(vararg paths: @Nullable Any?): JavaExec?

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 copyTo(options: JavaForkOptions?): JavaExec?

open fun copyTo(target: ProcessForkOptions?): JavaExec?

open fun debugOptions(action: Action<JavaDebugOptions?>?)

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 environment(environmentVariables: Map<String?, *>?): JavaExec?

open fun environment(name: String?, value: Any?): JavaExec?

open override fun exec()

open fun executable(executable: Any?): JavaExec?

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

open fun hasProperty(propertyName: String?): Boolean

open fun hasTaskActions(): Boolean

open fun jvmArgs(arguments: Iterable<*>?): JavaExec?

open fun jvmArgs(vararg arguments: Any?): JavaExec?

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 setArgsString(args: String?): JavaExec?

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?

systemProperties

open fun systemProperties(properties: Map<String?, out @Nullable Any?>?): JavaExec?

open fun systemProperty(name: String?, value: @Nullable Any?): JavaExec?

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

open fun workingDir(dir: Any?): JavaExec?