config

type Action struct {
	Repository  string          `required:"true" yaml:"repository"`
	Name        string          `required:"true" yaml:"name"`
	Enabled     bool            `default:"true" yaml:"enabled,omitempty"`
	Type        ActionType      `required:"true" yaml:"type"`
	Container   ContainerAction `yaml:"container,omitempty"` // Container contains the configuration for containerized actions
	Description string          `yaml:"description"`
	Version     string          `yaml:"version"`
	Scope       ActionScope     `required:"true" yaml:"scope"`
	Rules       []WorkflowRule  `yaml:"rules,omitempty"`
	Access      ActionAccess    `yaml:"access"`
}

type ActionAccess struct {
	Env []string `yaml:"env"`
}

type ActionScope string

type ActionType string

type BinaryExecutionCandidate struct {
	Binary  string
	Version string
	Type    ExecutionType

	// File holds the absolute path to the executable file
	File string

	// Image holds the container image
	Image string

	// ImageCache holds information about caching for containers
	ImageCache []ToolCacheDir

	// Mounts
	Mounts []ContainerMount

	// Security
	Security ToolSecurity
}

type BranchingConventionType string

type CIDConfig struct {
	Paths       PathConfig
	Mode        ExecutionType `default:"PREFER_LOCAL"`
	Conventions ProjectConventions
	Env         map[string]string

	// Catalog holds all currently known actions
	Catalog Catalog `yaml:"catalog,omitempty"`

	// Workflows holds all available workflows
	Workflows []Workflow `yaml:"workflows,omitempty"`

	// Dependencies holds a key value map of required versions
	Dependencies map[string]string `yaml:"dependencies,omitempty"`

	// LocalTools holds a list to lookup locally installed tools for command execution
	LocalTools []ToolLocal `yaml:"localtools,omitempty"`

	// ContainerImages holds a list of images that provide tools for command execution
	ContainerImages []ToolContainerImage `yaml:"containerimages,omitempty"`
}

type Catalog struct {
	Actions []Action `json:"actions"`
}

type CommitConventionType string

type ContainerAction struct {
	Image   string `yaml:"image"`   // Image is the full image reference including the registry
	Command string `yaml:"command"` // Command is the command that should be executed in the container image to start the action.
}

type ContainerMount struct {
	Src  string `yaml:"src"`
	Dest string `yaml:"dest"`
}

type ExecutionType string

type PathConfig struct {
	Artifact string `default:".dist"`
	Temp     string `default:".tmp"`
	Cache    string `default:""`
}

type PreferVersion string

type ProjectConventions struct {
	Branching        BranchingConventionType `default:"GitFlow"`
	Commit           CommitConventionType    `default:"ConventionalCommits"`
	PreReleaseSuffix string                  `default:"-rc.{NCI_LASTRELEASE_COMMIT_AFTER_COUNT}"`
}

type ToolBinary struct {
	Binary  string `yaml:"binary"`
	Version string `yaml:"version"`
}

type ToolCacheDir struct {
	ID            string
	ContainerPath string `yaml:"dir"`
	MountType     string `yaml:"type"`
}

type ToolContainerImage struct {
	Provides []ToolBinary   `yaml:"provides"`
	Image    string         `yaml:"image"`
	Cache    []ToolCacheDir `yaml:"cache"`
	Security ToolSecurity   `yaml:"security"`
	User     string         `yaml:"user"`

	// Mounts
	Mounts []ContainerMount `yaml:"mounts,omitempty"`
}

type ToolLocal struct {
	Binary         []string
	Lookup         []ToolLocalLookup
	LookupSuffixes []string `yaml:"lookup-suffixes"`
	Path           string
	ResolvedBinary string
}

type ToolLocalLookup struct {
	Key     string // env name
	Version string // version
}

type ToolSecurity struct {
	Capabilities []string `yaml:"capabilities"`
	Privileged   bool     `yaml:"privileged"`
}

type Workflow struct {
	Name   string          `required:"true" yaml:"name,omitempty"`
	Rules  []WorkflowRule  `yaml:"rules,omitempty"`
	Stages []WorkflowStage `yaml:"stages,omitempty"`
}

type WorkflowAction struct {
	ID     string                     `required:"true" yaml:"id"`
	Rules  []WorkflowRule             `yaml:"rules,omitempty"`
	Config interface{}                `yaml:"config,omitempty"`
	Module *analyzerapi.ProjectModule `yaml:"-"`
}

type WorkflowExpressionType string

type WorkflowRule struct {
	Type       WorkflowExpressionType `default:"cel" yaml:"type,omitempty"`
	Expression string                 `yaml:"expression,omitempty"`
}

type WorkflowStage struct {
	Name    string           `required:"true" yaml:"name,omitempty"`
	Rules   []WorkflowRule   `yaml:"rules,omitempty"`
	Actions []WorkflowAction `yaml:"actions,omitempty"`
}