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

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

constructor()

Properties

appId

var appId: <Error class: unknown class>

GitHub App application ID

clientId

var clientId: <Error class: unknown class>

GitHub App client ID

clientSecret

var clientSecret: <Error class: unknown class>

GitHub App client secret

displayName

var displayName: <Error class: unknown class>

Human friendly connection name

var id: String?

Project feature id, if not specified will be generated

ownerUrl

var ownerUrl: <Error class: unknown class>

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

params

val params: List<Parameter>

privateKey

var privateKey: <Error class: unknown class>

GitHub App private key

type

var type: String

Project feature type

webhookSecret

var webhookSecret: <Error class: unknown class>

GitHub App webhook secret

Functions

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