setup

Documentation

Index

• type BusSetup
  • func New(ctx context.Context, bus *logbus.Bus, ...) (*BusSetup, error)
  • func (bs *BusSetup) Close(ctx context.Context) error
  • func (bs *BusSetup) DumpManifestToFile(path string) error
  • func (bs *BusSetup) LogStreamerStarted() bool
  • func (bs *BusSetup) SetCI(isCI bool)
  • func (bs *BusSetup) SetDefaultPlatform(platform string)
  • func (bs *BusSetup) SetGitAuthor(gitAuthor, gitCommitEmail string)
  • func (bs *BusSetup) SetOrgAndProject(orgName, projectName string)
  • func (bs *BusSetup) StartLogStreamer(c *cloud.Client)

Types

type BusSetup

type BusSetup struct {
	Bus             *logbus.Bus
	ConsoleWriter   *writersub.WriterSub
	Formatter       *formatter.Formatter
	SolverMonitor   *solvermon.SolverMonitor
	BusDebugWriter  *writersub.RawWriterSub
	LogStreamer     *ship.LogShipper
	InitialManifest *logstream.RunManifest
	// contains filtered or unexported fields
}

BusSetup is a helper for setting up a logbus.Bus.

func New

func New(ctx context.Context, bus *logbus.Bus, debug, verbose, displayStats, forceColor, noColor, disableOngoingUpdates bool, busDebugFile, buildID string, execStatsTracker *execstatssummary.Tracker, isGitHubActions bool) (*BusSetup, error)

New creates a new BusSetup.

func (*BusSetup) Close

func (bs *BusSetup) Close(ctx context.Context) error

Close the bus setup & gather all errors.

func (*BusSetup) DumpManifestToFile

func (bs *BusSetup) DumpManifestToFile(path string) error

DumpManifestToFile dumps the manifest to the given file.

func (*BusSetup) LogStreamerStarted

func (bs *BusSetup) LogStreamerStarted() bool

LogStreamerStarted returns true if the log streamer has been started.

func (*BusSetup) SetCI

func (bs *BusSetup) SetCI(isCI bool)

SetCI tracks whether this build is being run in a CI environment.

func (*BusSetup) SetDefaultPlatform

func (bs *BusSetup) SetDefaultPlatform(platform string)

SetDefaultPlatform sets the default platform of the build.

func (*BusSetup) SetGitAuthor

func (bs *BusSetup) SetGitAuthor(gitAuthor, gitCommitEmail string)

SetGitAuthor records the Git author information on the initial manifest.

func (*BusSetup) SetOrgAndProject

func (bs *BusSetup) SetOrgAndProject(orgName, projectName string)

SetOrgAndProject sets the org and project for the manifest.

func (*BusSetup) StartLogStreamer

func (bs *BusSetup) StartLogStreamer(c *cloud.Client)

StartLogStreamer starts a LogStreamer for the given build. The LogStreamer streams logs to the cloud.