npm-publish-gradle-plugin/dev.petuska.npm.publish.task/NpmPublishTask

NpmPublishTask

@UntrackedTask(because = "Must always run")

abstract class NpmPublishTask : NpmExecTask

A publishing task that publishes a given package to a given registry.

Constructors

NpmPublishTask

constructor()

Properties

description

var description: @Nullable String

dry

@get:Input

abstract val dry: Property<Boolean>

Controls dry-tun mode for the execution.

enabled

@get:Internal

var enabled: Boolean

group

var group: @Nullable String

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

node

@get:InputFile

@get:PathSensitive(value = PathSensitivity.NAME_ONLY)

abstract val node: RegularFileProperty

Main NodeJS executable. Allows for executing any js script from your builds.

nodeHome

@get:InputDirectory

@get:PathSensitive(value = PathSensitivity.NAME_ONLY)

abstract val nodeHome: DirectoryProperty

Base NodeJS directory used to extract other node executables from. Defaults to 'NODE_HOME' env variable.

npm

@get:InputFile

@get:PathSensitive(value = PathSensitivity.NAME_ONLY)

abstract val npm: RegularFileProperty

NPM CLI executable. Use as argument to node executable as this is a JS script.

packageDir

@get:InputDirectory

abstract val packageDir: DirectoryProperty

The directory where the assembled and ready-to-publish package is

registry

abstract val registry: Property<NpmRegistry>

A registry to publish to

state

val state: TaskStateInternal

tag

@get:Input

@get:Optional

abstract val tag: Property<String>

Optional tag to label the published package version

timeout

val timeout: Property<Duration>

workingDir

@get:OutputDirectory

abstract val workingDir: DirectoryProperty

A working directory where final publishing layout is assembled.

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

debug

open fun debug(message: () -> String)

Logs at debug level

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)

error

open fun error(message: () -> String)

Logs at error level

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>

getDestroyables

open override fun getDestroyables(): TaskDestroyables

getDidWork

open override fun getDidWork(): Boolean

getExtensions

open override fun getExtensions(): ExtensionContainer

getFinalizedBy

open override fun getFinalizedBy(): TaskDependency

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

info

open fun info(message: () -> String)

Logs at info level

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

mustRunAfter

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

nodeExec

fun nodeExec(args: Collection<String?>, config: Action<ExecSpec> = Action {}): ExecResult

Executes a Node command

nodeHome

fun nodeHome(path: String)

Sets nodeHome

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

npmExec

fun npmExec(args: Collection<String?>, config: Action<ExecSpec> = Action {}): ExecResult

Executes an NPM command

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

registry

fun registry(action: Action<NpmRegistry>)

Configuration DSL allowing to modify a registry config

setActions

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

setDependsOn

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

setDidWork

open override fun setDidWork(didWork: Boolean)

setFinalizedBy

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

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

warn

open fun warn(message: () -> String)

Logs at warn level