Package io.github.cdklabs.projen.build
Interface BuildWorkflowCommonOptions
-
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
BuildWorkflowOptions,BuildWorkflowOptions
- All Known Implementing Classes:
BuildWorkflowCommonOptions.Jsii$Proxy,BuildWorkflowOptions.Jsii$Proxy,BuildWorkflowOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.100.0 (build 6a776be)", date="2024-06-21T23:10:11.874Z") @Stability(Experimental) public interface BuildWorkflowCommonOptions extends software.amazon.jsii.JsiiSerializable
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classBuildWorkflowCommonOptions.BuilderA builder forBuildWorkflowCommonOptionsstatic classBuildWorkflowCommonOptions.Jsii$ProxyAn implementation forBuildWorkflowCommonOptions
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static BuildWorkflowCommonOptions.Builderbuilder()default StringgetName()(experimental) Name of the buildfile (e.g.default JobPermissionsgetPermissions()(experimental) Permissions granted to the build job To limit job permissions forcontents, the desired permissions have to be explicitly set, e.g.:{ contents: JobPermission.NONE }.default List<JobStep>getPreBuildSteps()(experimental) Steps to execute before the build.default TriggersgetWorkflowTriggers()(experimental) Build workflow triggers.
-
-
-
Method Detail
-
getName
@Stability(Experimental) @Nullable default String getName()
(experimental) Name of the buildfile (e.g. "build" becomes "build.yml").Default: "build"
-
getPermissions
@Stability(Experimental) @Nullable default JobPermissions getPermissions()
(experimental) Permissions granted to the build job To limit job permissions forcontents, the desired permissions have to be explicitly set, e.g.:{ contents: JobPermission.NONE }.Default: `{ contents: JobPermission.WRITE }`
-
getPreBuildSteps
@Stability(Experimental) @Nullable default List<JobStep> getPreBuildSteps()
(experimental) Steps to execute before the build.Default: []
-
getWorkflowTriggers
@Stability(Experimental) @Nullable default Triggers getWorkflowTriggers()
(experimental) Build workflow triggers.Default: "{ pullRequest: {}, workflowDispatch: {} }"
-
builder
@Stability(Experimental) static BuildWorkflowCommonOptions.Builder builder()
- Returns:
- a
BuildWorkflowCommonOptions.BuilderofBuildWorkflowCommonOptions
-
-