Package io.github.cdklabs.projen.github

Interface GithubWorkflowOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GithubWorkflowOptions.Jsii$Proxy

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

(experimental) Options for GithubWorkflow.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GithubWorkflowOptions.Builder	builder()
default String	getConcurrency()	(experimental) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.
default Boolean	getForce()	(experimental) Force the creation of the workflow even if workflows is disabled in GitHub.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConcurrency

@Stability(Experimental)
@Nullable
default String getConcurrency()

(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

See Also:

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

getForce

@Stability(Experimental)
@Nullable
default Boolean getForce()

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

Default: false

builder

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

Returns:

a GithubWorkflowOptions.Builder of GithubWorkflowOptions