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

Github

class Github : CommitStatusPublisher.Publisher

Publish build statuses to GitHub.

Constructors

Github

constructor()

Types

AuthType

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

Properties

authType

var authType: CommitStatusPublisher.Publisher.Github.AuthType?

The authentication type.

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>

statusCheckName

var statusCheckName: String?

The status check name value for GitHub. Specifies the name of the check name displayed in the status message posted to the GitHub.

value

val value: String?

yamlName

val yamlName: 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>

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

findRawParam