Package io.github.cdklabs.projen.gitlab

Interface CiConfigurationOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CiConfigurationOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.118Z")
@Stability(Experimental)
public interface CiConfigurationOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for CiConfiguration.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CiConfigurationOptions.Builder	A builder for CiConfigurationOptions
static class	CiConfigurationOptions.Jsii$Proxy	An implementation for CiConfigurationOptions

Method Summary

Modifier and Type	Method	Description
static CiConfigurationOptions.Builder	builder()
default Default	getDefaultValue()	(experimental) Default settings for the CI Configuration.
default Map<String,Job>	getJobs()	(experimental) An initial set of jobs to add to the configuration.
default Job	getPages()	(experimental) A special job used to upload static sites to Gitlab pages.
default List<String>	getStages()	(experimental) Groups jobs into stages.
default Map<String,Object>	getVariables()	(experimental) Global variables that are passed to jobs.
default Workflow	getWorkflow()	(experimental) Used to control pipeline behavior.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDefaultValue

@Stability(Experimental)
@Nullable
default Default getDefaultValue()

(experimental) Default settings for the CI Configuration.

Jobs that do not define one or more of the listed keywords use the value defined in the default section.

getJobs

@Stability(Experimental)
@Nullable
default Map<String,Job> getJobs()

(experimental) An initial set of jobs to add to the configuration.

getPages

@Stability(Experimental)
@Nullable
default Job getPages()

(experimental) A special job used to upload static sites to Gitlab pages.

Requires a public/ directory with artifacts.path pointing to it.

getStages

@Stability(Experimental)
@Nullable
default List<String> getStages()

(experimental) Groups jobs into stages.

All jobs in one stage must complete before next stage is executed. If no stages are specified. Defaults to ['build', 'test', 'deploy'].

getVariables

@Stability(Experimental)
@Nullable
default Map<String,Object> getVariables()

(experimental) Global variables that are passed to jobs.

If the job already has that variable defined, the job-level variable takes precedence.

getWorkflow

@Stability(Experimental)
@Nullable
default Workflow getWorkflow()

(experimental) Used to control pipeline behavior.

builder

@Stability(Experimental)
static CiConfigurationOptions.Builder builder()

Returns:

a CiConfigurationOptions.Builder of CiConfigurationOptions