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
          useUniqueCallback = true // optional, false by default
        }
Content copied to clipboard
    }
}

Constructors

GitHubAppConnection

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

constructor()

Properties

appId

var appId: String?

GitHub App application ID

clientId

var clientId: String?

GitHub App client ID

clientSecret

var clientSecret: String?

GitHub App client secret

displayName

var displayName: String?

Human friendly connection name

var id: String?

Project feature id, if not specified will be generated

ownerUrl

var ownerUrl: String?

GitHub App installation owner URL (e.g. URL to a GitHub user or organization)

params

val params: List<Parameter>

privateKey

var privateKey: String?

GitHub App private key

type

var type: String

Project feature type

useUniqueCallback

var useUniqueCallback: Boolean?

If true, TeamCity adds a unique value to the callback URL, preventing your access token from being intercepted during a mix-up attack. The final callback URL is displayed inside a corresponding section of connection settings in TeamCity admin UI. The default value is false.

webhookSecret

var webhookSecret: String?

GitHub App webhook secret

Functions

booleanParameter

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

clear

fun clear()

compoundParameter

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