Package com.atlassian.bamboo.specs.builders.task

Class VcsCheckoutTask

  • public class VcsCheckoutTask
extends com.atlassian.bamboo.specs.api.builders.task.Task<VcsCheckoutTask,​VcsCheckoutTaskProperties>
    Represents task that checks out selected repositories to the build working directory.

    • Constructor Detail

      • VcsCheckoutTask

        public VcsCheckoutTask()

    • Method Detail

      • addCheckoutOfDefaultRepository

        public VcsCheckoutTask addCheckoutOfDefaultRepository()
        Adds checkout request for the plan's default repository into the build directory. Default repository is the repository which is the first on the list of plan's repositories.

        The repository will be checked out to the build's working directory. For more control over checkout path, use checkoutItems(CheckoutItem...).

      • addCheckoutOfRepository

        public VcsCheckoutTask addCheckoutOfRepository​(@NotNull
                                               @NotNull java.lang.String repositoryName)
        Adds checkout request for one of plan's repositories into the build directory.

        The repository will be checked out to the build's working directory. For more control over checkout path, use checkoutItems(CheckoutItem...).

      • addCheckoutOfRepository

        public VcsCheckoutTask addCheckoutOfRepository​(@NotNull
                                               @NotNull com.atlassian.bamboo.specs.api.builders.repository.VcsRepositoryIdentifier repositoryIdentifier)
        Adds checkout request for one of plan's repositories into the build directory.

        The repository will be checked out to the build's working directory. For more control over checkout path, use checkoutItems(CheckoutItem...).

      • cleanCheckout

        public VcsCheckoutTask cleanCheckout​(boolean cleanCheckout)
        Enables/disabled clean checkout. If set, the task cleans the content of the checkout target directory before checking out the source. Off by default.