TeamCity Kotlin DSL 2025.11/jetbrains.buildServer.configs.kotlin.buildFeatures/CommitStatusPublisher/Publisher/Github

Github

class Github : CommitStatusPublisher.Publisher

Publish status to GitHub

Constructors

Github

constructor()

Types

AuthType

sealed class AuthType : CompoundParam<CommitStatusPublisher.Publisher.Github.AuthType>

Properties

authType

var authType: CommitStatusPublisher.Publisher.Github.AuthType?

Type of authentication

githubUrl

var githubUrl: String?

GitHub server URL. Use "https://api.github.com" for projects hosted at github.com. For GitHub enterprise use the URL in the following format: http{s}://{host}:{port}/api/v3

params

val params: List<Parameter>

value

val value: String?

yamlParams

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

clear

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>

copyParamsTo

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>

enumParameter

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>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

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

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

param

fun param(name: String, value: String)

Adds parameter with specified name and value

password

fun password(init: CommitStatusPublisher.Publisher.Github.AuthType.Password.() -> Unit = {}): CommitStatusPublisher.Publisher.Github.AuthType.Password

Password authentication

personalToken

fun personalToken(init: CommitStatusPublisher.Publisher.Github.AuthType.PersonalToken.() -> Unit = {}): CommitStatusPublisher.Publisher.Github.AuthType.PersonalToken

Authentication using personal token

removeRawParam

fun removeRawParam(paramName: String)

storedToken

fun storedToken(init: CommitStatusPublisher.Publisher.Github.AuthType.StoredToken.() -> Unit = {}): CommitStatusPublisher.Publisher.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>

validate

open override fun validate(consumer: ErrorConsumer)

vcsRoot

fun vcsRoot(): CommitStatusPublisher.Publisher.Github.AuthType.VcsRoot

Use VCS root credentials