Package org.kohsuke.github

Class GHDeploymentBuilder

  • public class GHDeploymentBuilder
extends Object
    The type GHDeploymentBuilder.

    • Constructor Detail

      • GHDeploymentBuilder

        public GHDeploymentBuilder​(GHRepository repo)
        Instantiates a new Gh deployment builder.
        Parameters:
        repo - the repo

      • GHDeploymentBuilder

        public GHDeploymentBuilder​(GHRepository repo,
                           String ref)
        Instantiates a new Gh deployment builder.
        Parameters:
        repo - the repo
        ref - the ref

    • Method Detail

      • ref

        public GHDeploymentBuilder ref​(String branch)
        Ref gh deployment builder.
        Parameters:
        branch - the branch
        Returns:
        the gh deployment builder

      • task

        public GHDeploymentBuilder task​(String task)
        Task gh deployment builder.
        Parameters:
        task - the task
        Returns:
        the gh deployment builder

      • autoMerge

        public GHDeploymentBuilder autoMerge​(boolean autoMerge)
        Auto merge gh deployment builder.
        Parameters:
        autoMerge - the auto merge
        Returns:
        the gh deployment builder

      • requiredContexts

        public GHDeploymentBuilder requiredContexts​(List<String> requiredContexts)
        Required contexts gh deployment builder.
        Parameters:
        requiredContexts - the required contexts
        Returns:
        the gh deployment builder

      • payload

        public GHDeploymentBuilder payload​(String payload)
        Payload gh deployment builder.
        Parameters:
        payload - the payload
        Returns:
        the gh deployment builder

      • environment

        public GHDeploymentBuilder environment​(String environment)
        Environment gh deployment builder.
        Parameters:
        environment - the environment
        Returns:
        the gh deployment builder

      • transientEnvironment

        @Preview(ANT_MAN)
public GHDeploymentBuilder transientEnvironment​(boolean transientEnvironment)
        Deprecated.
        until preview feature has graduated to stable
        Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future.
        Parameters:
        transientEnvironment - the environment is transient
        Returns:
        the gh deployment builder

      • productionEnvironment

        @Preview(ANT_MAN)
public GHDeploymentBuilder productionEnvironment​(boolean productionEnvironment)
        Deprecated.
        until preview feature has graduated to stable
        Specifies if the given environment is one that end-users directly interact with.
        Parameters:
        productionEnvironment - the environment is used by end-users directly
        Returns:
        the gh deployment builder

      • description

        public GHDeploymentBuilder description​(String description)
        Description gh deployment builder.
        Parameters:
        description - the description
        Returns:
        the gh deployment builder