io.github.cdklabs.projen.github

Class GithubWorkflow

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.github.GithubWorkflow

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

TaskWorkflow

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.766Z")
 @Stability(value=Experimental)
public class GithubWorkflow
extends Component

(experimental) Workflow for GitHub.

A workflow is a configurable automated process made up of one or more jobs.

See Also:

https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	GithubWorkflow(GitHub github, String name)
	GithubWorkflow(GitHub github, String name, GithubWorkflowOptions options)
protected	GithubWorkflow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GithubWorkflow(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addJobs(Map<String,Job> jobs) (experimental) Add jobs to the workflow.
String	getConcurrency() (experimental) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.
YamlFile	getFile() (experimental) The workflow YAML file.
String	getName() (experimental) The name of the workflow.
void	on(Triggers events) (experimental) Add events to triggers the workflow.

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

getProject, postSynthesize, preSynthesize, synthesize

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

GithubWorkflow

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

GithubWorkflow

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

GithubWorkflow

@Stability(value=Experimental)
public GithubWorkflow(@NotNull
                                                     GitHub github,
                                                     @NotNull
                                                     String name,
                                                     @Nullable
                                                     GithubWorkflowOptions options)

Parameters:

github - This parameter is required.

name - This parameter is required.

options -

GithubWorkflow

@Stability(value=Experimental)
public GithubWorkflow(@NotNull
                                                     GitHub github,
                                                     @NotNull
                                                     String name)

Parameters:

github - This parameter is required.

name - This parameter is required.

Method Detail

addJobs

@Stability(value=Experimental)
public void addJobs(@NotNull
                                                   Map<String,Job> jobs)

(experimental) Add jobs to the workflow.

Parameters:

jobs - Jobs to add. This parameter is required.

on

@Stability(value=Experimental)
public void on(@NotNull
                                              Triggers events)

(experimental) Add events to triggers the workflow.

Parameters:

events - The event(s) to trigger the workflow. This parameter is required.

getName

@Stability(value=Experimental)
 @NotNull
public String getName()

(experimental) The name of the workflow.

getConcurrency

@Stability(value=Experimental)
 @Nullable
public String getConcurrency()

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

Default: disabled

getFile

@Stability(value=Experimental)
 @Nullable
public YamlFile getFile()

(experimental) The workflow YAML file.

May not exist if workflowsEnabled is false on GitHub.