pipelineyml

type Action struct {
	Alias       ActionAlias            `yaml:"alias,omitempty"`
	Description string                 `yaml:"description,omitempty"`
	Version     string                 `yaml:"version,omitempty"`
	Params      map[string]interface{} `yaml:"params,omitempty"`
	Labels      map[string]string      `yaml:"labels,omitempty"`

	Workspace string                       `yaml:"workspace,omitempty"`
	Image     string                       `yaml:"image,omitempty"`
	Commands  []string                     `yaml:"commands,omitempty"`
	Loop      *apistructs.PipelineTaskLoop `yaml:"loop,omitempty"`

	Timeout int64 `yaml:"timeout,omitempty"` // unit: second

	Resources Resources `yaml:"resources,omitempty"`

	Type ActionType `yaml:"-"`

	Caches []ActionCache `yaml:"caches,omitempty"` // action 构建缓存

	SnippetConfig *SnippetConfig `yaml:"snippet_config,omitempty"` // snippet 类型的 action 的配置

	If string `yaml:"if,omitempty"` // 条件执行

	// TODO 在未来版本中，可能去除 stage，依赖关系则必须通过 Needs 来声明。
	// 目前不开放给用户使用。由 parser 自动赋值。
	// Needs 显式声明依赖的 actions。隐式依赖关系是下一个 stage 依赖之前所有 stage 里的 action。
	// Needs 可以绕开 stage 限制，以 DAG 方式声明依赖关系。
	// Needs 一旦声明，只包含声明的值，不会注入其他依赖。
	Needs []ActionAlias `yaml:"-"`

	// TODO 该字段目前是兼容字段。
	// 在 1.1 版本中，Needs = NeedNamespaces
	// 在 1.0 版本中，Needs <= NeedNamespaces
	// 目前不开放给用户使用。由 parser 自动赋值。
	// NeedNamespaces 显式声明依赖的 namespaces。隐式依赖关系是下一个 stage 依赖之前所有 stage 的 namespaces。
	// NeedNamespaces 一旦声明，只包含声明的值，不会注入其他依赖。
	NeedNamespaces []string `yaml:"-"`

	// TODO 该字段目前是兼容字段，在未来版本中可以通过该字段扩展上下文。
	// 目前不开放给用户使用。由 parser 自动赋值。
	// Namespaces 显式声明 action 的命名空间，每个命名空间在流水线上下文目录下是唯一的，可以是目录或者文件。
	// 隐式命名空间为一个 alias，对应流水线上下文目录下的一个目录。
	// Namespaces 即使声明，同时会注入默认值 alias，也就是说每个 action 至少会有一个 namespace。
	Namespaces []string `yaml:"namespaces,omitempty"`
}

type ActionAlias string

type ActionCache struct {
	// 缓存生成的 key 或者是用户指定的 key
	// 用户指定的话 需要 {{basePath}}/路径/{{endPath}} 来自定义 key
	// 用户没有指定 key 有一定的生成规则, 具体生成规则看 prepare.go 的 setActionCacheStorageAndBinds 方法
	Key  string `yaml:"key,omitempty"`
	Path string `yaml:"path,omitempty"` // 指定那个目录被缓存, 只能是由 / 开始的绝对路径
}

type ActionType string

type CronCompensator struct {
	Enable               bool `yaml:"enable"`
	LatestFirst          bool `yaml:"latest_first"`
	StopIfLatterExecuted bool `yaml:"stop_if_latter_executed"`
}

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

type CronVisitorOption func(*CronVisitor)

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

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

type HandleResult struct {
	Errs  []error
	Warns []string
}

type MergeTrigger struct {
	Branches []string `yaml:"branches,omitempty"`
}

type NetworkHookInfo struct {
	Hook   string                 `json:"hook"`   // hook type
	Client string                 `json:"client"` // use network client
	Labels map[string]interface{} `json:"labels"` // additional information
}

type Option func(*PipelineYml)

type Outputs map[ActionAlias]map[string]string

type ParamsVisitor struct {
	Data              []byte
	RunPipelineParams []apistructs.PipelineRunParam
}

type PipelineOutput struct {
	Name string `json:"name,omitempty" yaml:"name,omitempty"` // 名称
	Desc string `json:"desc,omitempty" yaml:"desc,omitempty"` // 描述
	Ref  string `json:"ref,omitempty" yaml:"ref,omitempty"`   // 引用那个 action 的值
}

type PipelineParam struct {
	Name     string      `json:"name,omitempty" yaml:"name,omitempty"`         // 名称
	Required bool        `json:"required,omitempty" yaml:"required,omitempty"` // 是否必须
	Default  interface{} `json:"default,omitempty" yaml:"default,omitempty"`   // 默认值
	Desc     string      `json:"desc,omitempty" yaml:"desc,omitempty"`         // 描述
	Type     string      `json:"type,omitempty" yaml:"type,omitempty"`         // 类型
}

type PipelineYml struct {
	SnippetCaches []SnippetPipelineYmlCache // snippet 缓存
	// contains filtered or unexported fields
}

type PushTrigger struct {
	Branches []string `yaml:"branches,omitempty"`
	Tags     []string `yaml:"tags,omitempty"`
}

type RefOp struct {
	Ori string // ${alias:OPERATION:key}
	Ref string // ref: alias or namespace
	Op  string // OPERATION
	Key string // key
	Ex  string // Executor

	IsAlias           bool // 是否是 alias
	IsNamespace       bool // 是否是 namespace
	RefStageIndex     int  // ref 所属 stage index
	CurrentStageIndex int  // 当前 action 的 stage index
}

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

type Refs map[string]string

type Resources struct {
	CPU     float64           `yaml:"cpu,omitempty"`
	MaxCPU  float64           `yaml:"max_cpu,omitempty"`
	Mem     int               `yaml:"mem,omitempty"`
	Disk    int               `yaml:"disk,omitempty"`
	Network map[string]string `yaml:"network,omitempty"`
}

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

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

type SnippetConfig struct {
	Source string            `yaml:"source,omitempty"` // 来源 gittar dice test
	Name   string            `yaml:"name,omitempty"`   // 名称
	Labels map[string]string `yaml:"labels,omitempty"` // 额外标签
}

type SnippetPipelineYmlCache struct {
	SnippetConfig SnippetConfig
	PipelineYaml  *apistructs.PipelineYml
}

type Spec struct {
	Version string `yaml:"version"`

	On      *TriggerConfig `yaml:"on,omitempty"`
	Storage *StorageConfig `yaml:"storage,omitempty"`

	Envs map[string]string `yaml:"envs,omitempty"`

	Cron            string           `yaml:"cron,omitempty"`
	CronCompensator *CronCompensator `yaml:"cron_compensator,omitempty"`

	Stages []*Stage `yaml:"stages"`

	Params []*PipelineParam `yaml:"params,omitempty"` // 流水线输入

	Outputs []*PipelineOutput `yaml:"outputs,omitempty"` // 流水线输出

	// describe the use of network hooks in the pipeline
	Lifecycle []*NetworkHookInfo `yaml:"lifecycle,omitempty"`
	// contains filtered or unexported fields
}

type Stage struct {
	Actions []typedActionMap `yaml:"stage"`
}

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

type StorageConfig struct {
	Context string `json:"context"`
}

type TimeoutVisitor struct{}

type TriggerConfig struct {
	Push  *PushTrigger  `yaml:"push,omitempty"`
	Merge *MergeTrigger `yaml:"merge,omitempty"`
}

type VersionVisitor struct{}

type Visitable interface {
	Accept(v Visitor)
}

type Visitor interface {
	Visit(s *Spec)
}