Package io.github.cdklabs.projen.github

Class TaskWorkflow.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<TaskWorkflow>
    Enclosing class:
    TaskWorkflow
    @Stability(Experimental)
public static final class TaskWorkflow.Builder
extends Object
implements software.amazon.jsii.Builder<TaskWorkflow>
    (experimental) A fluent builder for TaskWorkflow.

    • Method Detail

      • permissions

        @Stability(Experimental)
public TaskWorkflow.Builder permissions​(JobPermissions permissions)
        (experimental) Permissions for the build job.

        Parameters:
        permissions - Permissions for the build job. This parameter is required.
        Returns:
        this

      • artifactsDirectory

        @Stability(Experimental)
public TaskWorkflow.Builder artifactsDirectory​(String artifactsDirectory)
        (experimental) A directory name which contains artifacts to be uploaded (e.g. dist). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail.

        Default: - not set

        Parameters:
        artifactsDirectory - A directory name which contains artifacts to be uploaded (e.g. dist). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail. This parameter is required.
        Returns:
        this

      • checkoutWith

        @Stability(Experimental)
public TaskWorkflow.Builder checkoutWith​(CheckoutWith checkoutWith)
        (experimental) Override for the with property of the source code checkout step.

        Default: - not set

        Parameters:
        checkoutWith - Override for the with property of the source code checkout step. This parameter is required.
        Returns:
        this

      • condition

        @Stability(Experimental)
public TaskWorkflow.Builder condition​(String condition)
        (experimental) Adds an 'if' condition to the workflow.

        Parameters:
        condition - Adds an 'if' condition to the workflow. This parameter is required.
        Returns:
        this

      • container

        @Stability(Experimental)
public TaskWorkflow.Builder container​(ContainerOptions container)
        Default: - default image

        Parameters:
        container - This parameter is required.
        Returns:
        this

      • downloadLfs

        @Stability(Experimental)
public TaskWorkflow.Builder downloadLfs​(Boolean downloadLfs)
        (experimental) Whether to download files from Git LFS for this workflow.

        Default: - Use the setting on the corresponding GitHub project

        Parameters:
        downloadLfs - Whether to download files from Git LFS for this workflow. This parameter is required.
        Returns:
        this

      • env

        @Stability(Experimental)
public TaskWorkflow.Builder env​(Map<String,​String> env)
        (experimental) Workflow environment variables.

        Default: {}

        Parameters:
        env - Workflow environment variables. This parameter is required.
        Returns:
        this

      • gitIdentity

        @Stability(Experimental)
public TaskWorkflow.Builder gitIdentity​(GitIdentity gitIdentity)
        (experimental) The git identity to use in this workflow.

        Parameters:
        gitIdentity - The git identity to use in this workflow. This parameter is required.
        Returns:
        this

      • jobDefaults

        @Stability(Experimental)
public TaskWorkflow.Builder jobDefaults​(JobDefaults jobDefaults)
        (experimental) Default settings for all steps in the TaskWorkflow Job.

        Parameters:
        jobDefaults - Default settings for all steps in the TaskWorkflow Job. This parameter is required.
        Returns:
        this

      • outputs

        @Stability(Experimental)
public TaskWorkflow.Builder outputs​(Map<String,​? extends JobStepOutput> outputs)
        (experimental) Mapping of job output names to values/expressions.

        Default: {}

        Parameters:
        outputs - Mapping of job output names to values/expressions. This parameter is required.
        Returns:
        this

      • postBuildSteps

        @Stability(Experimental)
public TaskWorkflow.Builder postBuildSteps​(List<? extends JobStep> postBuildSteps)
        (experimental) Actions to run after the main build step.

        Default: - not set

        Parameters:
        postBuildSteps - Actions to run after the main build step. This parameter is required.
        Returns:
        this

      • preBuildSteps

        @Stability(Experimental)
public TaskWorkflow.Builder preBuildSteps​(List<? extends JobStep> preBuildSteps)
        (experimental) Steps to run before the main build step.

        Default: - not set

        Parameters:
        preBuildSteps - Steps to run before the main build step. This parameter is required.
        Returns:
        this

      • preCheckoutSteps

        @Stability(Experimental)
public TaskWorkflow.Builder preCheckoutSteps​(List<? extends JobStep> preCheckoutSteps)
        (experimental) Initial steps to run before the source code checkout.

        Default: - not set

        Parameters:
        preCheckoutSteps - Initial steps to run before the source code checkout. This parameter is required.
        Returns:
        this

      • runsOn

        @Stability(Experimental)
public TaskWorkflow.Builder runsOn​(List<String> runsOn)
        (experimental) Github Runner selection labels.

        Default: ["ubuntu-latest"]

        Parameters:
        runsOn - Github Runner selection labels. This parameter is required.
        Returns:
        this

      • runsOnGroup

        @Stability(Experimental)
public TaskWorkflow.Builder runsOnGroup​(GroupRunnerOptions runsOnGroup)
        (experimental) Github Runner Group selection options.

        Parameters:
        runsOnGroup - Github Runner Group selection options. This parameter is required.
        Returns:
        this

      • name

        @Stability(Experimental)
public TaskWorkflow.Builder name​(String name)
        (experimental) The workflow name.

        Parameters:
        name - The workflow name. This parameter is required.
        Returns:
        this

      • task

        @Stability(Experimental)
public TaskWorkflow.Builder task​(Task task)
        (experimental) The main task to be executed.

        Parameters:
        task - The main task to be executed. This parameter is required.
        Returns:
        this

      • jobId

        @Stability(Experimental)
public TaskWorkflow.Builder jobId​(String jobId)
        (experimental) The primary job id.

        Default: "build"

        Parameters:
        jobId - The primary job id. This parameter is required.
        Returns:
        this

      • triggers

        @Stability(Experimental)
public TaskWorkflow.Builder triggers​(Triggers triggers)
        (experimental) The triggers for the workflow.

        Default: - by default workflows can only be triggered by manually.

        Parameters:
        triggers - The triggers for the workflow. This parameter is required.
        Returns:
        this

      • build

        @Stability(Experimental)
public TaskWorkflow build()
        Specified by:
        build in interface software.amazon.jsii.Builder<TaskWorkflow>
        Returns:
        a newly built instance of TaskWorkflow.