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"
        }
} }

See also

Constructors

Link copied to clipboard
fun ProjectReportTab(init: ProjectReportTab.() -> Unit)
Link copied to clipboard
fun ProjectReportTab()

Types

Link copied to clipboard
enum SourceBuildRule : Enum<ProjectReportTab.SourceBuildRule>

Specifies build where to search for report tab

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): SingleDelegateProvider<Boolean>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<T>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
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.

Link copied to clipboard
fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): SingleDelegateProvider<Int>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
fun stringParameter(customName: String? = null): SingleDelegateProvider<String>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

Link copied to clipboard
var buildType: String?

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

Link copied to clipboard
var id: String? = null

Project feature id, if not specified will be generated

Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var sourceBuildBranchFilter: String?

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

Link copied to clipboard
var sourceBuildNumber: String?

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

Link copied to clipboard
var sourceBuildRule: ProjectReportTab.SourceBuildRule?

The rule to select the build with report tab artifacts

Link copied to clipboard
var sourceBuildTag: String?

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

Link copied to clipboard
var startPage: String?

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

Link copied to clipboard
var title: String?

Report tab title

Link copied to clipboard
var type: String

Project feature type