TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.projectFeatures/GitHubIssueTracker

GitHubIssueTracker

open class GitHubIssueTracker : ProjectFeature

fun ProjectFeatures.githubIssues(init: GitHubIssueTracker.() -> Unit): 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
        }







Content copied to clipboard
    }
}

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
        }







Content copied to clipboard
    }
}

Constructors

GitHubIssueTracker

constructor(init: GitHubIssueTracker.() -> Unit)

constructor()

Types

AuthType

sealed class AuthType : CompoundParam<GitHubIssueTracker.AuthType>

Properties

authType

var authType: <Error class: unknown class>

displayName

var displayName: <Error class: unknown class>

Issue tracker integration display name.

var id: String?

Project feature id, if not specified will be generated

issuesPattern

var issuesPattern: <Error class: unknown class>

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

params

val params: List<Parameter>

repositoryURL

var repositoryURL: <Error class: unknown class>

GitHub server URL.

type

var type: String

Project feature type

Functions

accessToken

fun accessToken(init: GitHubIssueTracker.AuthType.AccessToken.() -> Unit = {}): GitHubIssueTracker.AuthType.AccessToken

anonymous

fun anonymous(): GitHubIssueTracker.AuthType.Anonymous

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): ProjectFeature

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.

doubleParameter

fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

findRawParam