build

package
v3.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2026 License: MIT Imports: 30 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CancelCmd

type CancelCmd struct {
	BuildNumber string `arg:"" help:"Build number to cancel"`
	Pipeline    string `help:"The pipeline to use. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." short:"p"`
	Web         bool   `help:"Open the build in a web browser after it has been cancelled." short:"w"`
}

func (*CancelCmd) Help

func (c *CancelCmd) Help() string

func (*CancelCmd) Run

func (c *CancelCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error

type CreateCmd

type CreateCmd struct {
	Message             string   `help:"Description of the build. If left blank, the commit message will be used once the build starts." short:"m"`
	Commit              string   `help:"The commit to build." short:"c" default:"HEAD"`
	Branch              string   `help:"The branch to build. Defaults to the default branch of the pipeline." short:"b"`
	Author              string   `help:"Author of the build. Supports: \"Name <email>\", \"email@domain.com\", \"Full Name\", or \"username\"" short:"a"`
	Web                 bool     `help:"Open the build in a web browser after it has been created." short:"w"`
	Pipeline            string   `help:"The pipeline to use. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." short:"p"`
	Env                 []string `help:"Set environment variables for the build (KEY=VALUE)" short:"e"`
	Metadata            []string `help:"Set metadata for the build (KEY=VALUE)" short:"M"`
	IgnoreBranchFilters bool     `help:"Ignore branch filters for the pipeline" short:"i"`
	EnvFile             string   `help:"Set the environment variables for the build via an environment file" short:"f"`
}

func (*CreateCmd) Help

func (c *CreateCmd) Help() string

func (*CreateCmd) Run

func (c *CreateCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error

type DownloadCmd

type DownloadCmd struct {
	BuildNumber string `arg:"" optional:"" help:"Build number to download (omit for most recent build)"`
	Pipeline    string `help:"The pipeline to use. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." short:"p"`
	Branch      string `help:"Filter builds to this branch." short:"b"`
	User        string `help:"Filter builds to this user. You can use name or email." short:"u" xor:"userfilter"`
	Mine        bool   `help:"Filter builds to only my user." short:"m" xor:"userfilter"`
}

func (*DownloadCmd) Help

func (c *DownloadCmd) Help() string

func (*DownloadCmd) Run

func (c *DownloadCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error

type ListCmd

type ListCmd struct {
	Pipeline string            `help:"The pipeline to use. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." short:"p"`
	Since    string            `help:"Filter builds created since this time (e.g. 1h, 30m)"`
	Until    string            `help:"Filter builds created before this time (e.g. 1h, 30m)"`
	Duration string            `help:"Filter by duration (e.g. >5m, <10m, 20m) - supports >, <, >=, <= operators"`
	State    []string          `help:"Filter by build state"`
	Branch   []string          `help:"Filter by branch name"`
	Creator  string            `help:"Filter by creator (email address or user ID)"`
	Commit   string            `help:"Filter by commit SHA"`
	Message  string            `help:"Filter by message content"`
	MetaData map[string]string `help:"Filter by build meta-data (key=value format, can be specified multiple times)"`
	Limit    int               `help:"Maximum number of builds to return" default:"50"`
	NoLimit  bool              `help:"Fetch all builds (overrides --limit)"`
	Output   string            `help:"Output format. One of: json, yaml, text" short:"o" default:"${output_default_format}" enum:"json,yaml,text"`
}

func (*ListCmd) Help

func (c *ListCmd) Help() string

func (*ListCmd) Run

func (c *ListCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error

type RebuildCmd

type RebuildCmd struct {
	BuildNumber string `arg:"" optional:"" help:"Build number to rebuild (omit for most recent build)"`
	Pipeline    string `help:"The pipeline to use. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." short:"p"`
	Branch      string `help:"Filter builds to this branch." short:"b"`
	User        string `help:"Filter builds to this user. You can use name or email." short:"u" xor:"userfilter"`
	Mine        bool   `help:"Filter builds to only my user." short:"m" xor:"userfilter"`
	Web         bool   `help:"Open the build in a web browser after it has been created." short:"w"`
}

func (*RebuildCmd) Help

func (c *RebuildCmd) Help() string

func (*RebuildCmd) Run

func (c *RebuildCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error

type ViewCmd

type ViewCmd struct {
	BuildNumber string `arg:"" optional:"" help:"Build number to view (omit for most recent build)"`
	Pipeline    string `help:"The pipeline to use. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." short:"p"`
	Branch      string `help:"Filter builds to this branch." short:"b"`
	User        string `help:"Filter builds to this user. You can use name or email." short:"u" xor:"userfilter"`
	Mine        bool   `help:"Filter builds to only my user." xor:"userfilter"`
	Web         bool   `help:"Open the build in a web browser." short:"w"`
	Output      string `help:"Output format. One of: json, yaml, text" short:"o" default:"${output_default_format}" enum:"json,yaml,text"`
}

func (*ViewCmd) Help

func (c *ViewCmd) Help() string

func (*ViewCmd) Run

func (c *ViewCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error

type WatchCmd

type WatchCmd struct {
	BuildNumber string `arg:"" optional:"" help:"Build number to watch (omit for most recent build)"`
	Pipeline    string `help:"The pipeline to use. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." short:"p"`
	Branch      string `help:"The branch to watch builds for." short:"b"`
	Interval    int    `help:"Polling interval in seconds" default:"1"`
}

func (*WatchCmd) Help

func (c *WatchCmd) Help() string

func (*WatchCmd) Run

func (c *WatchCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL