Package io.github.cdklabs.projen.build

Interface BuildWorkflowOptions

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    BuildWorkflowOptions.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.950Z")
@Stability(Experimental)
public interface BuildWorkflowOptions
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getArtifactsDirectory

        @Stability(Experimental)
@NotNull
String getArtifactsDirectory()
        (experimental) A name of a directory that includes build artifacts.

      • getBuildTask

        @Stability(Experimental)
@NotNull
Task getBuildTask()
        (experimental) The task to execute in order to build the project.

      • getContainerImage

        @Stability(Experimental)
@Nullable
default String getContainerImage()
        (experimental) The container image to use for builds.

        Default: - the default workflow container

      • getEnv

        @Stability(Experimental)
@Nullable
default Map<String,​String> getEnv()
        (experimental) Build environment variables.

        Default: {}

      • getGitIdentity

        @Stability(Experimental)
@Nullable
default GitIdentity getGitIdentity()
        (experimental) Git identity to use for the workflow.

        Default: - default identity

      • 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.

        This is enabled by default only if githubTokenSecret is set. Otherwise it is disabled, which implies that file changes that happen during build will not be pushed back to the branch.

        Default: true

      • 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 for contents, the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE }.

        Default: `{ contents: JobPermission.WRITE }`

      • getPostBuildSteps

        @Stability(Experimental)
@Nullable
default List<JobStep> getPostBuildSteps()
        (experimental) Steps to execute after build.

        Default: []

      • getPreBuildSteps

        @Stability(Experimental)
@Nullable
default List<JobStep> getPreBuildSteps()
        (experimental) Steps to execute before the build.

        Default: []

      • getRunsOn

        @Stability(Experimental)
@Nullable
default List<String> getRunsOn()
        (experimental) Github Runner selection labels.

        Default: ["ubuntu-latest"]

      • getRunsOnGroup

        @Stability(Experimental)
@Nullable
default GroupRunnerOptions getRunsOnGroup()
        (experimental) Github Runner Group selection options.

      • getWorkflowTriggers

        @Stability(Experimental)
@Nullable
default Triggers getWorkflowTriggers()
        (experimental) Build workflow triggers.

        Default: "{ pullRequest: {}, workflowDispatch: {} }"