TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.triggers/GitHubChecksTrigger

GitHubChecksTrigger

open class GitHubChecksTrigger : Trigger

fun Triggers.gitHubChecks(init: GitHubChecksTrigger.() -> Unit): GitHubChecksTrigger

GitHub Checks Webhook Trigger allows TeamCity to automatically run builds on every commit and communicate build statuses to GitHub as Checks page messages.

Example. Trigger a TeamCity build whenever a new change is pushed to a remote GitHub repository. In addition, this trigger posts detailed build result info to GitHub.

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        gitHubChecks { }
Content copied to clipboard
    }
}

Example. Disable links to TeamCity in detailed reports on the GitHub

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        gitHubChecks {
          disableLinksToTeamcity = true
        }
Content copied to clipboard
    }
}

Constructors

GitHubChecksTrigger

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

constructor()

Properties

buildParams

val buildParams: TriggerBuildParameters

Parameters that are added to triggered builds

disableLinksToTeamcity

var disableLinksToTeamcity: Boolean?

Disable TeamCity links in GitHub check run output

enabled

var enabled: Boolean

Specifies whether the trigger is enabled

enforceCleanCheckout

var enforceCleanCheckout: Boolean

Whether the build should be triggered with clean checkout

enforceCleanCheckoutForDependencies

var enforceCleanCheckoutForDependencies: Boolean

When the enforceCleanCheckout is set to true specifies whether the clean checkout should also be applied to all dependencies.

var id: String?

Trigger id, if not set will be generated

params

val params: List<Parameter>

type

var type: String

Trigger type

Functions

booleanParameter

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

buildParams

fun buildParams(init: TriggerBuildParameters.() -> Unit)

Configures build parameters that are applied to triggered builds

clear

fun clear()

clearBuildParams

fun clearBuildParams()

Deletes all configured build parameters

compoundParameter

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

copyParamsTo

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

Copies parameters of this object to the specified target

create

open fun create(): Trigger

Creates an instance of this trigger 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