plangenerate

type GeneratePlanRequest struct {
	Modules      []*analyzerapi.ProjectModule        `json:"modules"`
	Registry     catalog.Config                      `json:"registry"`
	ProjectDir   string                              `json:"project_dir"`
	Env          map[string]string                   `json:"env"`
	Executables  []executable.Executable             `json:"executables"`
	PinVersions  bool                                `json:"pin_versions"`
	Variables    []api.CIVariable                    `json:"variables"`
	Environments map[string]appcommon.VCSEnvironment `json:"environments"`
	WorkflowType string                              `json:"workflow_type"`
}

type Plan struct {
	Name              string                  `json:"name"`
	Stages            []string                `json:"stages"`
	Steps             []Step                  `json:"steps"`
	PinnedExecutables []executable.Executable `json:"pinned-executables,omitempty"`
}

type PlanContext struct {
	ProjectDir      string
	Environment     map[string]string
	Stages          []string
	VCSVariables    []api.CIVariable
	VCSEnvironments map[string]appcommon.VCSEnvironment
	Registry        catalog.Config
	Modules         []*analyzerapi.ProjectModule
}

type Stage struct {
	Name  string   `json:"name"`
	Steps []Step   `json:"steps,omitempty"`
	Needs []string `json:"needs,omitempty"`
}

type Step struct {
	ID                 string                 `json:"id"`
	Name               string                 `json:"name"`
	Slug               string                 `json:"slug"`
	Stage              string                 `json:"stage"`
	Scope              actionsdk.ActionScope  `json:"scope"`
	Action             string                 `json:"action"`
	Module             string                 `json:"module,omitempty"`
	ModuleDir          string                 `json:"module-dir,omitempty"`             // Directory of the module, if applicable
	RunAfter           []string               `json:"run-after,omitempty"`              // List of steps that need to be completed before this step starts (by slug)
	RunAfterByName     []string               `json:"run-after-by-name,omitempty"`      // List of steps that need to be completed before this step starts (by name)
	RunIfChanged       []string               `json:"run-if-changed,omitempty"`         // List of files that trigger this step if changed
	UsesOutputOf       []string               `json:"uses-output-of,omitempty"`         // List of steps whose outputs need to be downloaded (by slug)
	UsesOutputOfByName []string               `json:"uses-output-of-by-name,omitempty"` // List of steps whose outputs need to be downloaded (by name)
	Environment        string                 `json:"environment,omitempty"`
	Access             StepAccess             `json:"access,omitempty"`
	Inputs             actionsdk.ActionInput  `json:"inputs,omitempty"`
	Outputs            actionsdk.ActionOutput `json:"outputs,omitempty"`
	Order              int                    `json:"order"` // Topological order
	Config             interface{}            `json:"config,omitempty"`
}

type StepAccess struct {
	Environment []StepAccessEnv                    `json:"env,omitempty"`         // Environment variables that the step may access during execution
	Executables []actionsdk.ActionAccessExecutable `json:"executables,omitempty"` // Executables that the step may invoke during execution
	Network     StepAccessNetwork                  `json:"network,omitempty"`     // Network endpoints (host:port) that the step may use during execution
	Resources   []actionsdk.ActionAccessResource   `json:"resources,omitempty"`   // Resources the step may access (e.g. releases, packages, ...)
}

type StepAccessEnv struct {
	Name     string `json:"name"`
	Pattern  bool   `json:"pattern,omitempty"`
	Required bool   `json:"required,omitempty"`
	Secret   bool   `json:"secret,omitempty"`
}

type StepAccessNetwork []string

type StepMetadata struct {
	ExecutableConstraints map[string]string `json:"executable-constraints,omitempty"`
}