ns-scripting-core/net.democritus.scripting.git/GitFlowReleaseScope

GitFlowReleaseScope

interface GitFlowReleaseScope : ScriptScope(source)

This scoping object is created by accessing the GitFlowScope.release field. Its purpose is providing access to functionality for Git Flow releases.

Properties

ctx

abstract val ctx: ScopeContext

This field contains the context object that is applicable to the scope that defines the execution. The object is inherited directly from the parent net.democritus.scripting.scope.ScriptScope without alterations.

Functions

conditional

fun ScriptScope.conditional(condition: ScopeActivationCondition = always, body: ConditionalScope.() -> Unit)

A scoping function to execute a code block conditionally based on the declarative condition argument.

dir

fun ScriptScope.dir(dirPath: Path, body: DirScope.() -> Unit)

fun ScriptScope.dir(dirPath: String, body: DirScope.() -> Unit)

A scoping function to execute a code block within the context of a DirScope instance, which adapts the path in the scope context at ScopeContext.path to the given value of dirPath. The value of dirPath is automatically resolved if it is a relative path.

exec

fun ScriptScope.exec(body: ExecExecutionTemplate.() -> Unit)

This execution function is used to run a process on the machine. The body parameter is supplied as a higher-order function that executes within the scope of a ExecExecutionTemplate object, in which the arguments for the process can be declared.

finish

abstract fun finish(body: GitFlowReleaseFinishExecutionTemplate.() -> Unit)

Finalizes a release with the Git Flow plugin.

git

fun ScriptScope.git(condition: ScopeActivationCondition = always, body: GitScope.() -> Unit)

A scoping function to execute a code block within the context of an GitScope instance, which provides functionality to interact with Git source repositories.

mvn

fun ScriptScope.mvn(condition: ScopeActivationCondition = always, body: MavenExecutionTemplate.() -> Unit)

This execution function is used to run Maven. The body parameter is supplied as a higher-order function that executes within the scope of a MavenExecutionTemplate object, in which the parameters for Maven can be declared.

npm

fun ScriptScope.npm(condition: ScopeActivationCondition = always, body: NpmScope.() -> Unit)

A scoping function to execute a code block within the context of an NpmScope instance, which provides functionality to execute NPM commands.

fun ScriptScope.ns(condition: ScopeActivationCondition = always, body: NSScope.() -> Unit)

A scoping function to execute a code block within the context of an NSScope instance, which provides utility functions specific to NSX tooling.

start

abstract fun start(body: GitFlowReleaseStartExecutionTemplate.() -> Unit)

Starts a new release with the Git Flow plugin.