GitHubIssueTracker

Project feature enabling integration with GitHub issue tracker

Example. It is not recommended to store secure values such as tokens directly in the DSL code, see Managing Tokens section of our documentation.

project {
// Other Project settings ...
features {
// Other Project Features ...
        githubIssues {
id = "<Connection ID>" // arbitrary ID, must be unique in the project
displayName = "<Connection display name>"
repositoryURL = "<GitHub repository URL>"
authType = accessToken {
accessToken = "credentialsJSON:*****"
}
issuesPattern = "<Issue id pattern>" // optional, assumed #(\d+) if omitted
}
}
}

Example. Uses a GitHub App installation token stored in TeamCity.

project {
// Other Project settings ...
features {
// Other Project Features ...
        githubIssues {
id = "<Connection ID>" // arbitrary ID, must be unique in the project
displayName = "<Connection display name>"
repositoryURL = "<GitHub repository URL>"
authType = storedToken {
tokenId = "tc_token_id:*****"
}
issuesPattern = "<Issue id pattern>" // optional, assumed #(\d+) if omitted
}
}
}

See also

Constructors

Link copied to clipboard
constructor(init: GitHubIssueTracker.() -> Unit)
constructor()

Types

Link copied to clipboard

Properties

Link copied to clipboard
var authType: <Error class: unknown class>
Link copied to clipboard
var displayName: <Error class: unknown class>

Issue tracker integration display name.

Link copied to clipboard
var id: String?

Project feature id, if not specified will be generated

Link copied to clipboard
var issuesPattern: <Error class: unknown class>

Issues ID pattern. Use regex syntax, e.g. '#(\d+)'.

Link copied to clipboard
Link copied to clipboard
var repositoryURL: <Error class: unknown class>

GitHub server URL.

Link copied to clipboard

Project feature type

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard

Creates an instance of this project feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

Link copied to clipboard
fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
Link copied to clipboard
open fun stringParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard

Authentication via login/password is no longer supported by GitHub. We highly recommend that you authenticate with access tokens instead.

Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer