pipeline

package
v3.22.0 Latest Latest
Warning

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

Go to latest
Published: Jan 16, 2026 License: MIT Imports: 25 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConvertCmd added in v3.21.0

type ConvertCmd struct {
	File    string `help:"Path to the pipeline file to convert (required)" short:"F" required:""`
	Vendor  string `help:"CI/CD vendor (auto-detected if not specified)" short:"v"`
	AI      bool   `help:"Use AI-powered conversion (recommended for Jenkins)"`
	Output  string `help:"Custom path to save the converted pipeline (default: .buildkite/pipeline.<vendor>.yml)" short:"o"`
	Timeout int    `help:"Timeout in seconds (use 600+ for AI conversions)" default:"300"`
}

func (*ConvertCmd) Help added in v3.21.0

func (c *ConvertCmd) Help() string

func (*ConvertCmd) Run added in v3.21.0

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

type CopyCmd added in v3.17.0

type CopyCmd struct {
	Pipeline string `arg:"" help:"Source pipeline to copy (slug or org/slug). Uses current pipeline if not specified." optional:""`
	Target   string `help:"Name for the new pipeline, or org/name to copy to a different organization" short:"t"`
	Cluster  string `help:"Cluster name or ID for the new pipeline (required for cross-org copies if target org uses clusters)" short:"c"`
	DryRun   bool   `help:"Show what would be copied without creating the pipeline"`
	Output   string `help:"Output format: json, yaml, text" short:"o" default:"${output_default_format}" enum:",json,yaml,text"`
}

func (*CopyCmd) Help added in v3.17.0

func (c *CopyCmd) Help() string

func (*CopyCmd) Run added in v3.17.0

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

type CreateCmd

type CreateCmd struct {
	Name        string `arg:"" help:"Name of the pipeline" required:""`
	Description string `help:"Description of the pipeline" short:"d"`
	Repository  string `help:"Repository URL" short:"r"`
	ClusterID   string `help:"Cluster name or ID to assign the pipeline to" short:"c"`
	DryRun      bool   `help:"Simulate pipeline creation without actually creating it"`
	Output      string `` /* 129-byte string literal not displayed */
}

func (*CreateCmd) Help

func (c *CreateCmd) Help() string

func (*CreateCmd) Run

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

type ListCmd

type ListCmd struct {
	Name       string `help:"Filter pipelines by name (supports partial matches, case insensitive)" short:"n"`
	Repository string `help:"Filter pipelines by repository URL (supports partial matches, case insensitive)" short:"r"`
	Limit      int    `help:"Maximum number of pipelines to return (max: 3000)" short:"l" default:"100"`
	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 PipelineDryRun

type PipelineDryRun struct {
	ID                              string               `json:"id"`
	GraphQLID                       string               `json:"graphql_id"`
	URL                             string               `json:"url"`
	WebURL                          string               `json:"web_url"`
	Name                            string               `json:"name"`
	Description                     string               `json:"description"`
	Slug                            string               `json:"slug"`
	Repository                      string               `json:"repository"`
	ClusterID                       string               `json:"cluster_id"`
	ClusterURL                      string               `json:"cluster_url"`
	BranchConfiguration             string               `json:"branch_configuration"`
	DefaultBranch                   string               `json:"default_branch"`
	SkipQueuedBranchBuilds          bool                 `json:"skip_queued_branch_builds"`
	SkipQueuedBranchBuildsFilter    string               `json:"skip_queued_branch_builds_filter"`
	CancelRunningBranchBuilds       bool                 `json:"cancel_running_branch_builds"`
	CancelRunningBranchBuildsFilter string               `json:"cancel_running_branch_builds_filter"`
	BuildsURL                       string               `json:"builds_url"`
	BadgeURL                        string               `json:"badge_url"`
	CreatedAt                       *buildkite.Timestamp `json:"created_at"`
	Env                             map[string]any       `json:"env"`
	ScheduledBuildsCount            int                  `json:"scheduled_builds_count"`
	RunningBuildsCount              int                  `json:"running_builds_count"`
	ScheduledJobsCount              int                  `json:"scheduled_jobs_count"`
	RunningJobsCount                int                  `json:"running_jobs_count"`
	WaitingJobsCount                int                  `json:"waiting_jobs_count"`
	Visibility                      string               `json:"visibility"`
	Tags                            []string             `json:"tags"`
	Configuration                   string               `json:"configuration"`
	Steps                           []buildkite.Step     `json:"steps"`
	Provider                        buildkite.Provider   `json:"provider"`
	PipelineTemplateUUID            string               `json:"pipeline_template_uuid"`
	AllowRebuilds                   bool                 `json:"allow_rebuilds"`
	Emoji                           *string              `json:"emoji"`
	Color                           *string              `json:"color"`
	CreatedBy                       *buildkite.User      `json:"created_by"`
}

type ValidateCmd

type ValidateCmd struct {
	File []string `help:"Path to the pipeline YAML file(s) to validate" short:"f"`
}

func (*ValidateCmd) Help

func (c *ValidateCmd) Help() string

func (*ValidateCmd) Run

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

type ViewCmd

type ViewCmd struct {
	Pipeline string `arg:"" help:"The pipeline to view. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}." optional:""`
	Web      bool   `help:"Open the pipeline 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

Jump to

Keyboard shortcuts

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