TeamCity Kotlin DSL 2025.11/jetbrains.buildServer.configs.kotlin.buildFeatures/GitHubAppBuildScopedToken

GitHubAppBuildScopedToken

open class GitHubAppBuildScopedToken : BuildFeature

fun BuildFeatures.gitHubAppBuildScopedToken(init: GitHubAppBuildScopedToken.() -> Unit): GitHubAppBuildScopedToken

Build feature that issues a new GitHub App installation token for every build and revokes it after the build is finished.

Example. Configures a build-scoped token feature that issues a new GitHub App installation token for each build using a specified connection. The token will be stored in the specified parameter. It will give access only to the selected repositories with permissions granted to the GitHub App installation from the selected connection. It will be automatically revoked after the build's completion.

gitHubAppBuildScopedTokens {
    parameterName = "<MY_PARAMETER_NAME>" // add "env." prefix to make it environmental variable
    connectionId = "<connection ID>" // The connection should have the "allowBuildScopedTokens" parameter set to "true"

    // The repository name format is "myRepo1" for "https://github.com/myUser/myRepo1"
    targetRepositories = """
      myRepo1
      myRepo2
    """.trimIndent()
}

Constructors

GitHubAppBuildScopedToken

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

constructor()

Properties

connectionId

var connectionId: String?

ID of the GitHub App connection which will be used to issue tokens. The connection should have the allowBuildScopedTokens parameter set to true.

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

var id: String?

Build feature id, if not specified will be generated

parameterName

var parameterName: String?

Name of the parameter to which the issued token will be stored. You can prefix the parameter name with env. to make it an environmental variable.

params

val params: List<Parameter>

targetRepositories

var targetRepositories: String?

List of repositories to which issued token will have access, can't be empty. The list should contain only repositoriy names (e.g. "repo" for https://github.com/owner/repo).

type

var type: String

Build feature type

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

create

open fun create(): BuildFeature

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

doubleParameter