TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.projectFeatures/ProjectReportTab

ProjectReportTab

open class ProjectReportTab : ProjectFeature

fun ProjectFeatures.projectReportTab(init: ProjectReportTab.() -> Unit): ProjectReportTab

Project feature defining a custom tab to be shown on a project level

Example. Creates a tab on the project level which will show content produced by the latest build with tag "release" in the build configuration with id "MyBuild". The tab title is "Release Documentation".

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        projectReportTab {
          id = "MyProjectReportTab"
          title = "Release Documentation"
          startPage = "main.html"
          buildType = "MyBuild"
          sourceBuildRule = ProjectReportTab.SourceBuildRule.TAG
          sourceBuildTag = "release"
        }






Content copied to clipboard
    }
}

Constructors

ProjectReportTab

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

constructor()

Types

SourceBuildRule

enum SourceBuildRule : Enum<ProjectReportTab.SourceBuildRule>

Specifies build where to search for report tab

Properties

buildType

var buildType: <Error class: unknown class>

Id of a build configuration where to search for a build with report tab artifacts

var id: String?

Project feature id, if not specified will be generated

params

val params: List<Parameter>

sourceBuildBranchFilter

var sourceBuildBranchFilter: <Error class: unknown class>

A branch filter to limit the set of builds by their branches.

sourceBuildNumber

var sourceBuildNumber: <Error class: unknown class>

A build number for the build when BuildRule.BUILD_NUMBER rule is used

sourceBuildRule

var sourceBuildRule: <Error class: unknown class>

The rule to select the build with report tab artifacts

sourceBuildTag

var sourceBuildTag: <Error class: unknown class>

A tag for the build when BuildRule.TAG rule is used

startPage

var startPage: <Error class: unknown class>

Relative path to an artifact within build artifacts which should be used as a start page (eg, path to index.html)

title

var title: <Error class: unknown class>

Report tab title

type

var type: String

Project feature type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

copyParamsTo

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

Copies parameters of this object to the specified target

create

open fun create(): ProjectFeature

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

fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

findRawParam