build

Documentation

Overview

Package build provides a task for the Go toolchain "build" command.

Index

• Constants
• type Option
  • func WithBinaryArtifactName(name string) Option
  • func WithCrossCompileTargetPlatforms(platforms ...string) Option
  • func WithFlags(flags ...string) Option
  • func WithGoOptions(goOpts ...taskGo.Option) Option
  • func WithOutputDir(dir string) Option
• type Options
  • func NewOptions(opts ...Option) *Options
• type Task
  • func New(ac app.Config, opts ...Option) *Task
  • func (t *Task) BuildParams() []string
  • func (t *Task) Env() map[string]string
  • func (t *Task) Kind() task.Kind
  • func (t *Task) Name() string
  • func (t *Task) Options() task.Options

Constants

const (
	// DefaultDistOutputDirName is the default directory name for production and distribution builds.
	DefaultDistOutputDirName = "dist"
)

Types

type Option

type Option func(*Options)

Option is a task option.

func WithBinaryArtifactName

func WithBinaryArtifactName(name string) Option

WithBinaryArtifactName sets the name for the binary build artifact.

func WithCrossCompileTargetPlatforms

func WithCrossCompileTargetPlatforms(platforms ...string) Option

WithCrossCompileTargetPlatforms sets the names of cross-compile platform targets.

func WithFlags

func WithFlags(flags ...string) Option

WithFlags sets additional flags to pass to the Go `build` command along with the base Go flags.

func WithGoOptions

func WithGoOptions(goOpts ...taskGo.Option) Option

WithGoOptions sets shared Go toolchain task options.

func WithOutputDir

func WithOutputDir(dir string) Option

WithOutputDir sets the output directory, relative to the project root, for compilation artifacts.

type Options

type Options struct {
	*taskGo.Options

	// BinaryArtifactName is the name for the binary build artifact.
	BinaryArtifactName string

	// CrossCompileTargetPlatforms are the names of cross-compile platform targets.
	//
	// See `go tool dist list` and the `go` command documentations for more details:
	//   - https://github.com/golang/go/blob/master/src/cmd/dist/build.go
	CrossCompileTargetPlatforms []string

	// Flags are additional flags to pass to the Go `build` command along with the base Go flags.
	//
	// See `go help build` and the Go command documentation for more details:
	//   - https://golang.org/cmd/go/#hdr-Compile_packages_and_dependencies
	Flags []string

	// OutputDir is the output directory, relative to the project root, for compilation artifacts.
	OutputDir string
	// contains filtered or unexported fields
}

Options are task options.

func NewOptions

func NewOptions(opts ...Option) *Options

NewOptions creates new task options.

type Task

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

Task is a task for the Go toolchain "build" command.

func New

func New(ac app.Config, opts ...Option) *Task

New creates a new task for the Go toolchain "build" command.

func (*Task) BuildParams

func (t *Task) BuildParams() []string

BuildParams builds the parameters. Note that configured flags are applied after the "GOFLAGS" environment variable and could overwrite already defined flags.

See `go help environment`, `go help env` and the `go` command documentations for more details:

• https://golang.org/cmd/go/#hdr-Environment_variables

func (*Task) Env

func (t *Task) Env() map[string]string

Env returns the task specific environment.

func (*Task) Kind

func (t *Task) Kind() task.Kind

Kind returns the task kind.

func (*Task) Name

func (t *Task) Name() string

Name returns the task name.

func (*Task) Options

func (t *Task) Options() task.Options

Options returns the task options.