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

Package-level declarations

This package supplies APIs to interact with the Git versioning control system.

Several Git commands are implemented as execution builders that can be called from the git scope.

git {
  commit { // Adds all files in current directory to a new commit and tags it
    files(".")
    message("My commit message goes here")
    tag("1.0.0")
  }
  push { // Pushes the commits on the current branch as well as all tags
    tags()
  }
}

Types

GitCommitExecutionTemplate

interface GitCommitExecutionTemplate : ExecutionTemplate

The ExecutionTemplate which is created using the commit execution builder function. This template class is used as a builder to construct the arguments to create a commit with Git.

GitFlowReleaseFinishExecutionTemplate

interface GitFlowReleaseFinishExecutionTemplate : ExecutionTemplate

The ExecutionTemplate which is created using the GitFlowReleaseScope.finish execution builder function. This template class is used as a builder to construct the arguments to create a commit with Git.

GitFlowReleaseScope

interface GitFlowReleaseScope : ScriptScope

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

GitFlowReleaseStartExecutionTemplate

interface GitFlowReleaseStartExecutionTemplate : ExecutionTemplate

The ExecutionTemplate which is created using the GitFlowReleaseScope.start execution builder function. This template class is used as a builder to construct the arguments to create a commit with Git.

GitFlowScope

interface GitFlowScope : ScriptScope

This scope provider bundles functionality for the Git Flow workflow plugin.

GitPushExecutionTemplate

interface GitPushExecutionTemplate : ExecutionTemplate

The ExecutionTemplate which is created using the push execution builder function. This template class is used as a builder to construct the arguments for pushing refs to a remote with Git.

GitScope

interface GitScope : ScriptScope

This scoping object is created by the ScriptScope.git function. Its purpose is providing access to functionality such as execution functions that interact with Git source repositories.

GitTagExecutionTemplate

interface GitTagExecutionTemplate : ExecutionTemplate

The ExecutionTemplate which is created using the tag execution builder function. This template class is used as a builder to construct the arguments to tag a ref with Git.

Functions

commit

fun GitScope.commit(body: GitCommitExecutionTemplate.() -> Unit)

This execution function is used to create a new Git commit of the current state. The body parameter is supplied as a higher-order function that executes within the scope of an GitCommitExecutionTemplate object, in which the parameters for the expansion process can be declared.

flow

fun GitScope.flow(body: GitFlowScope.() -> Unit)

A scoping function to execute a code block within the context of an GitFlowScope instance, which provides functionality to perform aggregate Git operations with the Flow plugin.

git

fun ScriptScope.git(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.

push

fun GitScope.push(body: GitPushExecutionTemplate.() -> Unit)

This execution function is used to push Git refs to a remote. The body parameter is supplied as a higher-order function that executes within the scope of an GitPushExecutionTemplate object, in which the parameters for the expansion process can be declared.

tag

fun GitScope.tag(body: GitTagExecutionTemplate.() -> Unit)

This execution function is used to create a new Git tag of the current ref. The body parameter is supplied as a higher-order function that executes within the scope of an GitTagExecutionTemplate object, in which the parameters for the expansion process can be declared.