step

Documentation

Index

• type Config
• type GitCloneStep
  • func NewGitCloneStep(logger log.Logger, tracker tracker.StepTracker, ...) GitCloneStep
  • func (g GitCloneStep) ExportOutputs(runResult gitclone.CheckoutStateResult) error
  • func (g GitCloneStep) ProcessConfig() (Config, error)
  • func (g GitCloneStep) Run(cfg Config) (gitclone.CheckoutStateResult, error)
• type Input

Types

type Config

type Config struct {
	Input
}

Config is the git clone step configuration

type GitCloneStep

type GitCloneStep struct {
	// contains filtered or unexported fields
}

func NewGitCloneStep

func NewGitCloneStep(logger log.Logger, tracker tracker.StepTracker, inputParser stepconf.InputParser, envRepo env.Repository, cmdFactory command.Factory, pathModifier pathutil.PathModifier) GitCloneStep

func (GitCloneStep) ExportOutputs

func (g GitCloneStep) ExportOutputs(runResult gitclone.CheckoutStateResult) error

func (GitCloneStep) ProcessConfig

func (g GitCloneStep) ProcessConfig() (Config, error)

func (GitCloneStep) Run

func (g GitCloneStep) Run(cfg Config) (gitclone.CheckoutStateResult, error)

type Input

type Input struct {
	ShouldMergePR bool `env:"merge_pr,opt[yes,no]"`

	GitHTTPUsername string `env:"git_http_username"`
	GitHTTPPassword string `env:"git_http_password"`

	CloneIntoDir         string   `env:"clone_into_dir,required"`
	CloneDepth           int      `env:"clone_depth"`
	UpdateSubmodules     bool     `env:"update_submodules,opt[yes,no]"`
	SubmoduleUpdateDepth int      `env:"submodule_update_depth"`
	FetchTags            bool     `env:"fetch_tags,opt[yes,no]"`
	SparseDirectories    []string `env:"sparse_directories,multiline"`

	RepositoryURL           string `env:"repository_url,required"`
	Commit                  string `env:"commit"`
	Tag                     string `env:"tag"`
	Branch                  string `env:"branch"`
	PRDestBranch            string `env:"branch_dest"`
	PRSourceRepositoryURL   string `env:"pull_request_repository_url"`
	PRMergeBranch           string `env:"pull_request_merge_branch"`
	PRUnverifiedMergeBranch string `env:"pull_request_unverified_merge_branch"`
	PRHeadBranch            string `env:"pull_request_head_branch"`

	ResetRepository bool   `env:"reset_repository,opt[Yes,No]"`
	BuildURL        string `env:"build_url"`
	BuildAPIToken   string `env:"build_api_token"`
}