cmd

Documentation

Overview

Package cmd is beekeeper's command line.

Index

• Constants
• func Code(err error) int
• func Main() int
• func New() *cobra.Command

Constants

const (
	// ExitGateQueued: the merge waits on for its turn, or for the GitHub
	// budget's reset, in a run of its own, which wakes its owner with the
	// outcome.
	ExitGateQueued = 76
	// ExitGateRefused: a hold, a GitHub budget unknown or an unreadable
	// installation; nothing is queued.
	ExitGateRefused = 77
	// ExitGateDuplicate: the pull request's merge already runs, devctl's
	// "not applicable".
	ExitGateDuplicate = 3
	// GatePrefix starts every line the gate prints.
	GatePrefix = "beekeeper gate: "
	// DefaultGateWait is a foreground merge's wait for its turn before it
	// waits on in a run of its own; the hook gives a background one
	// BackgroundGateWait.
	DefaultGateWait    = 2 * time.Minute
	BackgroundGateWait = 30 * time.Minute
)

The gate's own exit codes, apart from devctl's 1-9 and the busy machine's 75.

const (
	ExitError    = 1
	ExitUsage    = 2
	ExitRefused  = 3
	ExitRelieved = 4
	ExitVault    = 78
	ExitOutdated = 125
)

Exit codes: 0 done, 1 error, 2 usage, 3 refused (a lease held or not granted, a hold set, the budget under its floor, a platform part this build does not have, a save by a release older than the one that wrote the state), 4 relieved (supervisor status in the session a relay relieved), 69 central unreachable (ExitCentral: a central verb whose instance did not answer), 78 vault (ExitVault: beekeeper secret could not read the shared vault: none configured, no token, op failing or silent), 125 outdated (a newer release exists: self-update --check, the status devctl's version check and muster's self-update --check use).

const ExitCentral = 69

ExitCentral is a central verb refused because the central instance is unreachable: there is no local copy to act on instead.

Functions

func Code

func Code(err error) int

Code returns the exit code err asks for.

func Main

func Main() int

Main runs the command line and returns the process exit code. An error without a message (a wrapped command's exit code) prints nothing.

func New

func New() *cobra.Command

New returns the root command.