Package io.github.cdklabs.projen.build

Class BuildWorkflow

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.build.BuildWorkflow

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.949Z")
@Stability(Experimental)
public class BuildWorkflow
extends Component

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	BuildWorkflow(Project project, BuildWorkflowOptions options)
protected	BuildWorkflow(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BuildWorkflow(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addPostBuildJob(String id, Job job)	(experimental) Adds another job to the build workflow which is executed after the build job succeeded.
void	addPostBuildJobCommands(String id, List<String> commands)	(experimental) Run a sequence of commands as a job within the build workflow which is executed after the build job succeeded.
void	addPostBuildJobCommands(String id, List<String> commands, AddPostBuildJobCommandsOptions options)	(experimental) Run a sequence of commands as a job within the build workflow which is executed after the build job succeeded.
void	addPostBuildJobTask(Task task)	(experimental) Run a task as a job within the build workflow which is executed after the build job succeeded.
void	addPostBuildJobTask(Task task, AddPostBuildJobTaskOptions options)	(experimental) Run a task as a job within the build workflow which is executed after the build job succeeded.
void	addPostBuildSteps(@NotNull JobStep... steps)	(experimental) Adds steps that are executed after the build.
List<String>	getBuildJobIds()	(experimental) Returns a list of job IDs that are part of the build.
String	getName()	(experimental) Name of generated github workflow.

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

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

BuildWorkflow

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

BuildWorkflow

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

BuildWorkflow

@Stability(Experimental)
public BuildWorkflow(@NotNull
                     Project project,
                     @NotNull
                     BuildWorkflowOptions options)

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

addPostBuildJob

@Stability(Experimental)
public void addPostBuildJob(@NotNull
                            String id,
                            @NotNull
                            Job job)

(experimental) Adds another job to the build workflow which is executed after the build job succeeded.

Jobs are executed only if the build did NOT self mutate. If the build self-mutate, the branch will either be updated or the build will fail (in forks), so there is no point in executing the post-build job.

Parameters:

id - The id of the new job. This parameter is required.

job - The job specification. This parameter is required.

addPostBuildJobCommands

@Stability(Experimental)
public void addPostBuildJobCommands(@NotNull
                                    String id,
                                    @NotNull
                                    List<String> commands,
                                    @Nullable
                                    AddPostBuildJobCommandsOptions options)

(experimental) Run a sequence of commands as a job within the build workflow which is executed after the build job succeeded.

Jobs are executed only if the build did NOT self mutate. If the build self-mutate, the branch will either be updated or the build will fail (in forks), so there is no point in executing the post-build job.

Parameters:

id - This parameter is required.

commands - This parameter is required.

options - Specify tools and other options.

addPostBuildJobCommands

@Stability(Experimental)
public void addPostBuildJobCommands(@NotNull
                                    String id,
                                    @NotNull
                                    List<String> commands)

(experimental) Run a sequence of commands as a job within the build workflow which is executed after the build job succeeded.

Jobs are executed only if the build did NOT self mutate. If the build self-mutate, the branch will either be updated or the build will fail (in forks), so there is no point in executing the post-build job.

Parameters:

id - This parameter is required.

commands - This parameter is required.

addPostBuildJobTask

@Stability(Experimental)
public void addPostBuildJobTask(@NotNull
                                Task task,
                                @Nullable
                                AddPostBuildJobTaskOptions options)

(experimental) Run a task as a job within the build workflow which is executed after the build job succeeded.

The job will have access to build artifacts and will install project dependencies in order to be able to run any commands used in the tasks.

Jobs are executed only if the build did NOT self mutate. If the build self-mutate, the branch will either be updated or the build will fail (in forks), so there is no point in executing the post-build job.

Parameters:

task - This parameter is required.

options - Specify tools and other options.

addPostBuildJobTask

@Stability(Experimental)
public void addPostBuildJobTask(@NotNull
                                Task task)

(experimental) Run a task as a job within the build workflow which is executed after the build job succeeded.

The job will have access to build artifacts and will install project dependencies in order to be able to run any commands used in the tasks.

Jobs are executed only if the build did NOT self mutate. If the build self-mutate, the branch will either be updated or the build will fail (in forks), so there is no point in executing the post-build job.

Parameters:

task - This parameter is required.

addPostBuildSteps

@Stability(Experimental)
public void addPostBuildSteps(@NotNull
                              @NotNull JobStep... steps)

(experimental) Adds steps that are executed after the build.

Parameters:

steps - The job steps. This parameter is required.

getBuildJobIds

@Stability(Experimental)
@NotNull
public List<String> getBuildJobIds()

(experimental) Returns a list of job IDs that are part of the build.

getName

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

(experimental) Name of generated github workflow.