Package io.github.cdklabs.projen.gitlab

Class CiConfiguration.Builder

java.lang.Object

io.github.cdklabs.projen.gitlab.CiConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CiConfiguration>

Enclosing class:

CiConfiguration

@Stability(Experimental)
public static final class CiConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<CiConfiguration>

(experimental) A fluent builder for CiConfiguration.

Method Summary

Modifier and Type	Method	Description
CiConfiguration	build()
static CiConfiguration.Builder	create(Project project, String name)
CiConfiguration.Builder	defaultValue(Default defaultValue)	(experimental) Default settings for the CI Configuration.
CiConfiguration.Builder	jobs(Map<String,? extends Job> jobs)	(experimental) An initial set of jobs to add to the configuration.
CiConfiguration.Builder	pages(Job pages)	(experimental) A special job used to upload static sites to Gitlab pages.
CiConfiguration.Builder	stages(List<String> stages)	(experimental) Groups jobs into stages.
CiConfiguration.Builder	variables(Map<String,? extends Object> variables)	(experimental) Global variables that are passed to jobs.
CiConfiguration.Builder	workflow(Workflow workflow)	(experimental) Used to control pipeline behavior.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static CiConfiguration.Builder create(Project project,
                                             String name)

Parameters:

project - This parameter is required.

name - This parameter is required.

Returns:

a new instance of CiConfiguration.Builder.

defaultValue

@Stability(Experimental)
public CiConfiguration.Builder defaultValue(Default defaultValue)

(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.

Parameters:

defaultValue - Default settings for the CI Configuration. This parameter is required.

Returns:

this

jobs

@Stability(Experimental)
public CiConfiguration.Builder jobs(Map<String,? extends Job> jobs)

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

Parameters:

jobs - An initial set of jobs to add to the configuration. This parameter is required.

Returns:

this

pages

@Stability(Experimental)
public CiConfiguration.Builder pages(Job pages)

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

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

Parameters:

pages - A special job used to upload static sites to Gitlab pages. This parameter is required.

Returns:

this

stages

@Stability(Experimental)
public CiConfiguration.Builder stages(List<String> stages)

(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'].

Parameters:

stages - Groups jobs into stages. This parameter is required.

Returns:

this

variables

@Stability(Experimental)
public CiConfiguration.Builder variables(Map<String,? extends Object> variables)

(experimental) Global variables that are passed to jobs.

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

Parameters:

variables - Global variables that are passed to jobs. This parameter is required.

Returns:

this

workflow

@Stability(Experimental)
public CiConfiguration.Builder workflow(Workflow workflow)

(experimental) Used to control pipeline behavior.

Parameters:

workflow - Used to control pipeline behavior. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public CiConfiguration build()

Specified by:

build in interface software.amazon.jsii.Builder<CiConfiguration>

Returns:

a newly built instance of CiConfiguration.