Package io.github.cdklabs.projen.javascript

Interface BuildWorkflowOptions

All Superinterfaces:

BuildWorkflowCommonOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BuildWorkflowOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.100.0 (build 6a776be)",
           date="2024-06-21T23:10:12.111Z")
@Stability(Experimental)
public interface BuildWorkflowOptions
extends software.amazon.jsii.JsiiSerializable, BuildWorkflowCommonOptions

(experimental) Build workflow options for NodeProject.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BuildWorkflowOptions.Builder	builder()
default Boolean	getMutableBuild()	(experimental) Automatically update files modified during builds to pull-request branches.

Methods inherited from interface io.github.cdklabs.projen.build.BuildWorkflowCommonOptions

getName, getPermissions, getPreBuildSteps, getWorkflowTriggers

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMutableBuild

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

(experimental) Automatically update files modified during builds to pull-request branches.

This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.

Implies that PR builds do not have anti-tamper checks.

Default: true

builder

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

Returns:

a BuildWorkflowOptions.Builder of BuildWorkflowOptions