ore

Documentation

Index

• Variables
• type Action
  • func (o *Action) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, ...) error
• type Alloy
  • func (o *Alloy) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, ...) (err error)
• type Cache
  • func (o *Cache) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, ...) error
• type Lava
  • func (o *Lava) GetFrom() forge.Ore
  • func (o *Lava) GetTo() forge.Ore
  • func (o *Lava) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, ...) (err error)
• type Pure
  • func (o *Pure) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, ...) error
• type Resource
  • func (o *Resource) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, ...) error
• type Task
  • func (o *Task) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, ...) error

Variables

var ErrContainerExitedWithNonzeroExitCode = errors.New("container exited with nonzero exit code")

Types

type Action

type Action struct {
	ID            string                       `json:"id,omitempty"`
	Uses          string                       `json:"uses,omitempty"`
	With          map[string]string            `json:"with,omitempty"`
	Env           map[string]string            `json:"env,omitempty"`
	GlobalContext *githubactions.GlobalContext `json:"global_context,omitempty"`
}

Action is an Ore representing a GitHub Action. That is--a step in a GitHub Actions Workflow that uses the `uses` key.

func (*Action) Liquify

func (o *Action) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, drains *forge.Drains) error

type Alloy

type Alloy struct {
	ID   string      `json:"id,omitempty"`
	Ores []forge.Ore `json:"ores,omitempty"`
}

Alloy is an Ore made up of other Ores that share a volume that is mounted to their WorkingDir.

func (*Alloy) Liquify

func (o *Alloy) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, drains *forge.Drains) (err error)

type Cache

type Cache struct {
	forge.Ore
}

Cache is an Ore that caches the output of other Ores.

func (*Cache) Liquify

func (o *Cache) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, drains *forge.Drains) error

type Lava

type Lava struct {
	From forge.Ore `json:"from,omitempty"`
	To   *Pure     `json:"to,omitempty"`
}

Lava is an Ore representing two Ores of which the stdout of the first is piped to the stdin of the second.

func (*Lava) GetFrom

func (o *Lava) GetFrom() forge.Ore

func (*Lava) GetTo

func (o *Lava) GetTo() forge.Ore

func (*Lava) Liquify

func (o *Lava) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, drains *forge.Drains) (err error)

type Pure

type Pure struct {
	Image      string   `json:"image,omitempty"`
	Entrypoint []string `json:"entrypoint,omitempty"`
	Cmd        []string `json:"cmd,omitempty"`
	Env        []string `json:"env,omitempty"`
	Input      []byte   `json:"input,omitempty"`
}

Pure is an Ore for running a "pure" command inside of a container.

func (*Pure) Liquify

func (o *Pure) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, drains *forge.Drains) error

type Resource

type Resource struct {
	Method       string                  `json:"method,omitempty"`
	Version      map[string]any          `json:"version,omitempty"`
	Params       map[string]any          `json:"params,omitempty"`
	Resource     *concourse.Resource     `json:"resource,omitempty"`
	ResourceType *concourse.ResourceType `json:"resource_type,omitempty"`
}

Resource is an Ore representing a Concourse Resource-- any of get, put or check.

func (*Resource) Liquify

func (o *Resource) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, drains *forge.Drains) error

type Task

type Task struct {
	Task      string            `json:"task,omitempty"`
	Inputs    map[string]string `json:"inputs,omitempty"`
	Execution string            `json:"execution,omitempty"`
}

func (*Task) Liquify

func (o *Task) Liquify(ctx context.Context, containerRuntime forge.ContainerRuntime, drains *forge.Drains) error