TeamCity Kotlin DSL 2025.11/jetbrains.buildServer.configs.kotlin.buildFeatures/PullRequests/Provider/Github

Github

class Github : PullRequests.Provider

GitHub or GitHub Enterprise

Constructors

constructor()

Types

sealed class AuthType : CompoundParam<PullRequests.Provider.Github.AuthType>

Properties

var authType: PullRequests.Provider.Github.AuthType?

Type of authentication

filterAuthorRole

var filterAuthorRole: PullRequests.GitHubRoleFilter?

Filter by the role of pull request contributors

filterSourceBranch

var filterSourceBranch: String?

Filter by source branch

filterTargetBranch

var filterTargetBranch: String?

Filter by target branch

var ignoreDrafts: Boolean?

Whether to ignore draft pull requests

val params: List<Parameter>

var serverUrl: String?

GitHub/GHE server URL

val value: String?

val yamlParams: List<Parameter>

Functions

booleanParameter

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

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

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<T>

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

Copies parameters of this object to the specified target

doubleParameter

fun doubleParameter(customName: String? = null): DelegateProvider<Double>

fun doubleParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<Double>

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): DelegateProvider<E>

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null, yamlName: String? = null): DelegateProvider<E>

fun findRawParam(paramName: String): Parameter?

fun hasParam(paramName: String): Boolean

fun intParameter(customName: String? = null): DelegateProvider<Int>

fun intParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<Int>

fun param(name: String, value: String)

Adds parameter with specified name and value

fun removeRawParam(paramName: String)

fun storedToken(init: PullRequests.Provider.Github.AuthType.StoredToken.() -> Unit = {}): PullRequests.Provider.Github.AuthType.StoredToken

Use GitHub App credentials

stringParameter

open fun stringParameter(customName: String? = null): DelegateProvider<String>

open fun stringParameter(customName: String? = null, yamlName: String? = null): DelegateProvider<String>

fun token(init: PullRequests.Provider.Github.AuthType.Token.() -> Unit = {}): PullRequests.Provider.Github.AuthType.Token

Authentication using access token

open override fun validate(consumer: ErrorConsumer)

fun vcsRoot(): PullRequests.Provider.Github.AuthType.VcsRoot

Use VCS root credentials