task

Documentation

Overview

Package task GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Index

• Variables
• type Checkpoint
  • func (Checkpoint) AsCheckpoint() bool
  • func (Checkpoint) CacheDisabled() bool
  • func (Checkpoint) Do(ctx context.Context) error
  • func (v Checkpoint) RuntimeDoc(names ...string) ([]string, bool)
• type Client
• type Group
  • func (Group) CacheDisabled() bool
  • func (v Group) RuntimeDoc(names ...string) ([]string, bool)
  • func (v *Group) T() cueflow.Task
  • func (v *Group) UnmarshalTask(t cueflow.Task) error
• type Secret
  • func (v Secret) RuntimeDoc(names ...string) ([]string, bool)
  • func (s Secret) String() string
• type SetupTask
  • func (v SetupTask) RuntimeDoc(names ...string) ([]string, bool)
  • func (SetupTask) Setup() bool
• type Store
  • func (s *Store[K, V]) Get(k K) (V, bool)
  • func (s *Store[K, V]) Set(v V) string
• type Task
  • func (t *Task) Done(err error)
  • func (v Task) RuntimeDoc(names ...string) ([]string, bool)
  • func (t *Task) Success() bool

Variables

var ClientContext = contextx.New[Client]()

var Factory = cueflow.NewTaskFactory("piper.octohelm.tech")

var SecretContext = contextx.New[*Store[string, Secret]](
	contextx.WithDefaultsFunc[*Store[string, Secret]](func() *Store[string, Secret] {
		return SecretStore
	}),
)

var SecretStore = &Store[string, Secret]{}

var WorkDirContext = contextx.New[*record.Map[string, wd.WorkDir]](
	contextx.WithDefaultsFunc[*record.Map[string, wd.WorkDir]](func() *record.Map[string, wd.WorkDir] {
		return WorkDirStore
	}),
)

var WorkDirStore = &record.Map[string, wd.WorkDir]{}

Types

type Checkpoint

type Checkpoint struct {
	// no need the ok
	Task `json:"-"`
}

func (Checkpoint) AsCheckpoint

func (Checkpoint) AsCheckpoint() bool

func (Checkpoint) CacheDisabled

func (Checkpoint) CacheDisabled() bool

func (Checkpoint) Do

func (Checkpoint) Do(ctx context.Context) error

func (Checkpoint) RuntimeDoc

func (v Checkpoint) RuntimeDoc(names ...string) ([]string, bool)

type Client

type Client interface {
	SourceDir(ctx context.Context) (wd.WorkDir, error)
	CacheDir(ctx context.Context, tpe string) (wd.WorkDir, error)
}

type Group

type Group struct {
	Task
	// contains filtered or unexported fields
}

func (Group) CacheDisabled

func (Group) CacheDisabled() bool

func (Group) RuntimeDoc

func (v Group) RuntimeDoc(names ...string) ([]string, bool)

func (*Group) T

func (v *Group) T() cueflow.Task

func (*Group) UnmarshalTask

func (v *Group) UnmarshalTask(t cueflow.Task) error

type Secret

type Secret struct {
	Key   string
	Value string
}

func (Secret) RuntimeDoc

func (v Secret) RuntimeDoc(names ...string) ([]string, bool)

func (Secret) String

func (s Secret) String() string

type SetupTask

type SetupTask struct {
	Task
}

func (SetupTask) RuntimeDoc

func (v SetupTask) RuntimeDoc(names ...string) ([]string, bool)

func (SetupTask) Setup

func (SetupTask) Setup() bool

type Store

type Store[K comparable, V fmt.Stringer] struct {
	// contains filtered or unexported fields
}

func (*Store[K, V]) Get

func (s *Store[K, V]) Get(k K) (V, bool)

func (*Store[K, V]) Set

func (s *Store[K, V]) Set(v V) string

type Task

type Task struct {
	// task hook to make task could run after some others
	Dep any `json:"$dep,omitempty"`
	// task result
	Ok *bool `json:"-" output:"$ok,omitempty"`

	cueflow.TaskImpl
}

func (*Task) Done

func (t *Task) Done(err error)

func (Task) RuntimeDoc

func (v Task) RuntimeDoc(names ...string) ([]string, bool)

func (*Task) Success

func (t *Task) Success() bool