command

Documentation

Index

• Constants
• type PreflightChecklist
• type PreflightInfo
  • func RunPreflightChecks(ctx context.Context, checklist PreflightChecklist) (PreflightInfo, error)

Constants

const (
	// Success is the exit code when a command execution is successful.
	Success int = iota
	// GenericError is the generic exit code when something fails.
	GenericError
	// ConfigError is the exit code when reading the config file fails.
	ConfigError
	// SpecError is the exit code when reading the spec file fails.
	SpecError
	// FlagError is the exit code when an undefined or invalid flag is provided to a command.
	FlagError
	// PreflightError is the exit code when a preflight check fails.
	PreflightError
	// OSError is the exit code when an OS operation fails.
	OSError
	// GoError is the exit code when a go command fails.
	GoError
	// GitError is the exit code when a git command fails.
	GitError
	// GPGError is the exit code when a gpg command fails.
	GPGError
	// GitHubError is the exit code when a GitHub request fails.
	GitHubError
	// ChangelogError is the exit code when generating the changelog fails.
	ChangelogError
)

Types

type PreflightChecklist

type PreflightChecklist struct {
	GPG bool
	Git bool
	Go  bool
}

PreflightChecklist is a list of common preflight checks for commands.

type PreflightInfo

type PreflightInfo struct {
	WorkingDirectory string

	GPG struct {
		Version string
	}

	Git struct {
		Version string
	}

	Go struct {
		Version string
	}
}

PreflightInfo is a list of common preflight information for commands.

func RunPreflightChecks

func RunPreflightChecks(ctx context.Context, checklist PreflightChecklist) (PreflightInfo, error)

RunPreflightChecks runs a list of preflight checks to ensure they are fulfilled. It returns a list of preflight information.