Package io.github.cdklabs.projen.gitlab

Class GitlabConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.gitlab.CiConfiguration

io.github.cdklabs.projen.gitlab.GitlabConfiguration

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.120Z")
@Stability(Experimental)
public class GitlabConfiguration
extends CiConfiguration

(experimental) A GitLab CI for the main .gitlab-ci.yml file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitlabConfiguration.Builder	(experimental) A fluent builder for GitlabConfiguration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	GitlabConfiguration(Project project)
	GitlabConfiguration(Project project, CiConfigurationOptions options)
protected	GitlabConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GitlabConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	createNestedTemplates(Map<String,CiConfigurationOptions> config)	(experimental) Creates and adds nested templates to the includes of the main CI.
Map<String,NestedConfiguration>	getNestedTemplates()

Methods inherited from class io.github.cdklabs.projen.gitlab.CiConfiguration

addDefaultCaches, addGlobalVariables, addIncludes, addJobs, addServices, addStages, getDefaultAfterScript, getDefaultArtifacts, getDefaultBeforeScript, getDefaultCache, getDefaultImage, getDefaultInterruptible, getDefaultRetry, getDefaultTags, getDefaultTimeout, getFile, getJobs, getName, getPages, getPath, getStages, getVariables, getWorkflow

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

GitlabConfiguration

protected GitlabConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

GitlabConfiguration

protected GitlabConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GitlabConfiguration

@Stability(Experimental)
public GitlabConfiguration(@NotNull
                           Project project,
                           @Nullable
                           CiConfigurationOptions options)

Parameters:

project - This parameter is required.

options -

GitlabConfiguration

@Stability(Experimental)
public GitlabConfiguration(@NotNull
                           Project project)

Parameters:

project - This parameter is required.

Method Detail

createNestedTemplates

@Stability(Experimental)
public void createNestedTemplates(@NotNull
                                  Map<String,CiConfigurationOptions> config)

(experimental) Creates and adds nested templates to the includes of the main CI.

Additionally adds their stages to the main CI if they are not already present. You can futher customize nested templates through the nestedTemplates property. E.g. gitlabConfig.nestedTemplates['templateName']?.addStages('stageName')

Parameters:

config - a record the names and configuraitons of the templates. This parameter is required.

getNestedTemplates

@Stability(Experimental)
@NotNull
public Map<String,NestedConfiguration> getNestedTemplates()