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 Equal(a, b *client) bool
- func New(opts ...Opt) (*client, error)
- type MockedClient
- type Opt
- func WithBuild(b *library.Build) Opt
- func WithHostname(hostname string) Opt
- func WithMockStdout(mock bool) 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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type MockedClient ¶ added in v0.15.0
MockedClient is for internal use to facilitate testing the local executor.
type Opt ¶
type Opt func(*client) error
Opt represents a configuration option to initialize the executor client for Local.
func WithHostname ¶
WithHostname sets the hostname in the executor client for Local.
func WithMockStdout ¶ added in v0.15.0
WithMockStdout adds a mock stdout writer to the client if mock is true. If mock is true, then you must use a goroutine to read from MockStdout as quickly as possible, or writing to stdout will hang.
func WithPipeline ¶
WithPipeline sets the pipeline build in the executor client for Local.
func WithRuntime ¶
WithRuntime sets the runtime engine in the executor client for Local.
func WithVelaClient ¶
WithVelaClient sets the Vela client in the executor client for Local.
func WithVersion ¶
WithVersion sets the version in the executor client for Local.
Source Files