actions

type Action struct {
	SchemaVersion        string               `yaml:"SchemaVersion"`        // version of the action schema
	Name                 string               `yaml:"Name"`                 // name of the action
	ID                   string               `yaml:"Id"`                   // ID of the action
	Description          string               `yaml:"Description"`          // description of the action
	Version              string               `yaml:"Version"`              // version of the action
	Configuration        map[string]Parameter `yaml:"Configuration"`        // define the configuration properties of the action
	SupportedComputeType SupportedComputeType `yaml:"SupportedComputeType"` // specify the compute types to use for the action
	Environment          Environment          `yaml:"Environment"`          // specify the CodeCatalyst environment to use with the action
	Inputs               Inputs               `yaml:"Inputs"`               // defines the data that an action needs during a workflow run
	Outputs              Outputs              `yaml:"Outputs"`              // defines the data that is output by the action during a workflow run. If more than 10 output variables are produced, the top 10 variables are selected
	Runs                 Runs                 `yaml:"Runs"`                 // defines the runtime environment and main entry point for the action
	Basedir              string               `yaml:"-"`                    // the directory this action was loaded from
}

type ActionProvider interface {
	Action() *Action
}

type ActionRunSummaryLevel string

type ActionRunSummaryMessage struct {
	Text              string                      // text of the message
	Level             ActionRunSummaryLevel       // level of the message
	Message           string                      // template to be used with TemplateVariables
	TemplateVariables []ActionRunTemplateVariable // variables to apply in the message template
}

type ActionRunTemplateVariable struct {
	Name  string
	Value string
}

type Artifacts struct {
	Required bool `yaml:"Required"` // if true, then action expects at least one artifact
}

type Environment struct {
	Required bool `yaml:"Required"` // if true, the action requires an environment
}

type Inputs struct {
	Sources   Sources   // Specify the labels that represent the source repositories that will be needed by the action
	Artifacts Artifacts // Specify artifacts from previous actions that you want to provide as input to this action
}

type NewActionPlanParams struct {
	Action        *Action              // Action to use to create a plan from
	ExecutionType runner.ExecutionType // Type of execution (shell or docker)
	WorkingDir    string               // Working directory for the plan
	ID            string               // override the id of the action
	Steps         []string             // override commands to run
	DependsOn     []string             // dependencies
}

type NewActionPlansProviderParams struct {
	ActionsProvider Provider             // The actions [Provider] containing the actions to create plans for
	ExecutionType   runner.ExecutionType // The [ExecutionType] to use in the created plans
	WorkingDir      string               // The working directory to use for each plan
}

type Output struct {
	Description string `yaml:"Description"` // provide a description of the output variable
}

type Outputs struct {
	Variables map[string]Output `yaml:"Variables"` // specify the variables that you want the action to export so that they are available for use by the subsequent actions.
}

type Parameter struct {
	Description string        `yaml:"Description"` // provide a description of the parameter
	Required    bool          `yaml:"Required"`    // specify whether the parameter is required
	Default     string        `yaml:"Default"`     // specify the default value of the parameter
	DisplayName string        `yaml:"DisplayName"` // set the display name of the parameter
	Type        ParameterType `yaml:"Type"`        // the type of the parameter: number, boolean, or string
}

type ParameterType string

type Provider interface {
	Actions() ([]*Action, error)
}

type Runs struct {
	Using UsingType `yaml:"Using"` // specify the type of runtime environment. Currently, Node 12, Node 16 and Docker are the options

	// Using == 'node16'
	Main string `yaml:"Main"` // specify the file for the entry point of a Node.js application. This file contains your action code. Required if Node 12 or Node 16 runtime is specified for Using
	Pre  string `yaml:"Pre"`  // allows you to run a script at the beginning of the action run. Can be defined if Node 12 or Node 16 runtime is specified for Using
	Post string `yaml:"Post"` // allows your to run a script at the end of the action run. Can be defined if Node 12 or Node 16 runtime is specified for Using

	// Using == 'docker'
	Image          string `yaml:"Image"`          // specify the file or link to an image. If a link is specified, it's not validated. This is the Docker image used as the container to run the action. Required if Docker runtime is specified for Using
	Entrypoint     string `yaml:"Entrypoint"`     // overrides the Docker entrypoint in the Docker file. Can be defined if Docker runtime is specified for Using.
	PreEntryPoint  string `yaml:"PreEntryPoint"`  // allows you to run a script before the entrypoint action begins. Can be defined if Docker runtime is specified for Using.
	PostEntryPoint string `yaml:"PostEntryPoint"` // allows you to run a cleanup script once the entrypoint action has finished. Can be defined if Docker runtime is specified for Using.
}

type Sources struct {
	Required bool `yaml:"Required"` // if true, then action expects at least one source
}

type SupportedComputeType string

type UsingType string