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

GitHubAppConnection

open class GitHubAppConnection : ProjectFeature

fun ProjectFeatures.githubAppConnection(init: GitHubAppConnection.() -> Unit): GitHubAppConnection

Project feature defining a single level connection with a GitHub App. Such a connection encompasses both application and installation level settings.

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

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        githubAppConnection {
          id = "<Connection ID>" // arbitrary ID that can be later used to refer to the connection
          displayName = "<Connection display name>"
          appId = "<GitHub App ID>"
          clientId = "<GitHub App Client ID>"
          clientSecret = "credentialsJSON:*****"
          privateKey = "credentialsJSON:*****"
          ownerUrl = "https://github.com/owner"
          webhookSecret = "credentialsJSON:*****" //optional
        }
Content copied to clipboard
    }
}

Constructors

GitHubAppConnection

fun GitHubAppConnection(init: GitHubAppConnection.() -> Unit)

GitHubAppConnection

fun GitHubAppConnection()

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): SingleDelegateProvider<Boolean>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<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