local

Documentation

Overview

Package local provides the ability for Vela to integrate with the local system.

Usage:

import "github.com/go-vela/worker/executor/local"

Index

• func New(opts ...Opt) (*client, error)
• type Opt
  • func WithBuild(b *library.Build) Opt
  • func WithHostname(hostname string) Opt
  • func WithPipeline(p *pipeline.Build) Opt
  • func WithRepo(r *library.Repo) Opt
  • func WithRuntime(r runtime.Engine) Opt
  • func WithUser(u *library.User) Opt
  • func WithVelaClient(cli *vela.Client) Opt
  • func WithVersion(version string) Opt

Functions

func New

func New(opts ...Opt) (*client, error)

New returns an Executor implementation that integrates with the local system.

nolint: golint // ignore unexported type as it is intentional

Types

type Opt

type Opt func(*client) error

Opt represents a configuration option to initialize the client.

func WithBuild

func WithBuild(b *library.Build) Opt

WithBuild sets the library build in the client.

func WithHostname

func WithHostname(hostname string) Opt

WithHostname sets the hostname in the client.

func WithPipeline

func WithPipeline(p *pipeline.Build) Opt

WithPipeline sets the pipeline build in the client.

func WithRepo

func WithRepo(r *library.Repo) Opt

WithRepo sets the library repo in the client.

func WithRuntime

func WithRuntime(r runtime.Engine) Opt

WithRuntime sets the runtime engine in the client.

func WithUser

func WithUser(u *library.User) Opt

WithUser sets the library user in the client.

func WithVelaClient

func WithVelaClient(cli *vela.Client) Opt

WithVelaClient sets the Vela client in the client.

func WithVersion

func WithVersion(version string) Opt

WithVersion sets the version in the client.