actions

package

v0.1.88 Latest Latest Go to latest Published: Apr 19, 2024 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func As[T any](t any) (*T, error)

func Load[T Action](content []byte) (*T, error)

Load function, *T must satisfy Action

func RegisterBuilder(typeName string, builder BuilderFunc)

func Run(ctx context.Context, action Action) (any, error)

func SetActionTracker(actionTracker *ActionTracker)

func Validate(_ context.Context, input proto.Message) error

Validate action input

type Action interface {
	Run(ctx context.Context) (any, error)
	Command() string
}

func CreateAction(content []byte) (Action, error)

type ActionSave struct {
	Command string          `json:"command"`
	Data    json.RawMessage `json:"data"`
}

type ActionStep struct {
	Step   int
	Data   *json.RawMessage `json:"data"`
	Action Action
}

type ActionTracker struct {
	Dir    string
	Replay bool
}

func NewActionTracker(ctx context.Context, group string) (*ActionTracker, error)

func (tracker *ActionTracker) GetActions(_ context.Context) ([]Action, error)

func (tracker *ActionTracker) NextStep() int

func (tracker *ActionTracker) Save(action Action) error

func (tracker *ActionTracker) WithDir(dir string)

type BuilderFunc func(content []byte) (Action, error)

func Wrap[T Action]() BuilderFunc

Wrap function with a constraint that *T satisfies Action

type Config struct {
	Kind string `json:"kind"`
}