io.github.cdklabs.projen.github

Class GithubWorkflow.Builder

java.lang.Object

io.github.cdklabs.projen.github.GithubWorkflow.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GithubWorkflow>

Enclosing class:

GithubWorkflow

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

(experimental) A fluent builder for GithubWorkflow.

Method Summary

Modifier and Type	Method and Description
GithubWorkflow	build()
GithubWorkflow.Builder	concurrency(String concurrency) (experimental) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.
static GithubWorkflow.Builder	create(GitHub github, String name)
GithubWorkflow.Builder	force(Boolean force) (experimental) Force the creation of the workflow even if `workflows` is disabled in `GitHub`.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static GithubWorkflow.Builder create(GitHub github,
                                                                           String name)

Parameters:

github - This parameter is required.

name - This parameter is required.

Returns:

a new instance of GithubWorkflow.Builder.

concurrency

@Stability(value=Experimental)
public GithubWorkflow.Builder concurrency(String concurrency)

(experimental) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.

Currently in beta.

Default: - disabled

Parameters:

concurrency - Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. This parameter is required.

Returns:

this

See Also:

https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#concurrency

force

@Stability(value=Experimental)
public GithubWorkflow.Builder force(Boolean force)

(experimental) Force the creation of the workflow even if `workflows` is disabled in `GitHub`.

Default: false

Parameters:

force - Force the creation of the workflow even if `workflows` is disabled in `GitHub`. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public GithubWorkflow build()

Specified by:

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