pipeline

type DeployOptions struct {
	ConfigPath  string
	Environment string
	EnvFile     string
	DeployInfra bool
	SkipSSM     bool
	SkipConfig  bool
	DryRun      bool
	StreamLogs  bool
	Wait        bool
	TailLines   int
	Message     string
	Out         io.Writer // where progress is written; nil means os.Stdout
	Version     string    // citadel version, recorded in .citadel/project.yml
}

type Deployer interface {
	Update(ctx context.Context, w io.Writer, cfg *config.DeployConfig, env, imageURI string) error
	WaitStable(ctx context.Context, w io.Writer, cfg *config.DeployConfig, env string) error
}

type Step interface {
	Name() string
	// Plan runs right before the step and decides whether it runs. It may
	// print to out and perform read-only checks (e.g. deploy's CDK-rollout
	// check). true means skip: the step is recorded as skipped.
	Plan(ctx context.Context, sc *StepContext, out io.Writer) (bool, error)
	// Run performs the step, writing to w (terminal + the step's log file).
	Run(ctx context.Context, sc *StepContext, w io.Writer) error
}

type StepContext struct {
	Cfg            *config.DeployConfig
	Opts           *DeployOptions
	Env            string
	Vars           map[string]string
	ImageURI       string
	SecretsUpdated int
	Target         string
	// Before is the rollback snapshot: the ECS task-definition ARN or the
	// Lambda image URI running before this deploy ("" when none was taken).
	Before string
	// Record closes the ~/.citadel/deployments.db row; set by the deploy step.
	Record func(error)
	// contains filtered or unexported fields
}