GitHubAppConnection

open class GitHubAppConnection : ProjectFeature

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
}
}
}

See also

Constructors

Link copied to clipboard
fun GitHubAppConnection(init: GitHubAppConnection.() -> Unit)
Link copied to clipboard
fun GitHubAppConnection()

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): SingleDelegateProvider<Boolean>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<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
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.

Link copied to clipboard
fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>
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): SingleDelegateProvider<Int>
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
fun stringParameter(customName: String? = null): SingleDelegateProvider<String>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

Link copied to clipboard
var appId: String?

GitHub App application ID

Link copied to clipboard
var clientId: String?

GitHub App client ID

Link copied to clipboard
var clientSecret: String?

GitHub App client secret

Link copied to clipboard
var displayName: String?

Human friendly connection name

Link copied to clipboard
var id: String? = null

Project feature id, if not specified will be generated

Link copied to clipboard
var ownerUrl: String?

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

Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var privateKey: String?

GitHub App private key

Link copied to clipboard
var type: String

Project feature type

Link copied to clipboard
var webhookSecret: String?

GitHub App webhook secret