runner

Documentation

Index

• type Opt
  • func WithLogger(logger *zerolog.Logger) Opt
  • func WithStderr(stderr io.Writer) Opt
  • func WithStdout(stdout io.Writer) Opt
• type Runner
  • func New(config string, opts ...Opt) *Runner
  • func (r *Runner) Run(ctx context.Context) error

Types

type Opt

type Opt func(r *Runner)

Opt is a functional option for Runner.

func WithLogger

func WithLogger(logger *zerolog.Logger) Opt

WithLogger sets the logger for the Runner.

func WithStderr

func WithStderr(stderr io.Writer) Opt

WithStderr sets the writer to which the GitHub runner writes its stderr.

func WithStdout

func WithStdout(stdout io.Writer) Opt

WithStdout sets the writer to which the GitHub runner writes its stdout.

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

Runner represents a virtual machine agent that's responsible for running the actual GitHub runner.

func New

func New(config string, opts ...Opt) *Runner

New creates a new Runner.

func (*Runner) Run

func (r *Runner) Run(ctx context.Context) error

Start starts the GitHub runner. This requires the GitHub runner to be configured first. If the GitHub runner is already running, this is a no-op.