common

Documentation

Index

• Variables
• func After(_ *cli.Context) error
• func Before(c *cli.Context) error
• func DetectPipelineConfig() (isDir bool, config string, _ error)
• func FormatFlag(tmpl string, hidden ...bool) *cli.StringFlag
• func OutputFlags(def string) []cli.Flag
• func RunPipelineFunc(c *cli.Context, fileFunc, dirFunc func(*cli.Context, string) error) error

Variables

var GlobalFlags = append([]cli.Flag{
	&cli.StringFlag{
		EnvVars: []string{"WOODPECKER_CONFIG"},
		Name:    "config",
		Aliases: []string{"c"},
		Usage:   "path to config file",
	},
	&cli.StringFlag{
		EnvVars: []string{"WOODPECKER_SERVER"},
		Name:    "server",
		Aliases: []string{"s"},
		Usage:   "server address",
	},
	&cli.StringFlag{
		EnvVars: []string{"WOODPECKER_TOKEN"},
		Name:    "token",
		Aliases: []string{"t"},
		Usage:   "server auth token",
	},
	&cli.BoolFlag{
		EnvVars: []string{"WOODPECKER_DISABLE_UPDATE_CHECK"},
		Name:    "disable-update-check",
		Usage:   "disable update check",
	},
	&cli.BoolFlag{
		EnvVars: []string{"WOODPECKER_SKIP_VERIFY"},
		Name:    "skip-verify",
		Usage:   "skip ssl verification",
		Hidden:  true,
	},
	&cli.StringFlag{
		EnvVars: []string{"SOCKS_PROXY"},
		Name:    "socks-proxy",
		Usage:   "socks proxy address",
		Hidden:  true,
	},
	&cli.BoolFlag{
		EnvVars: []string{"SOCKS_PROXY_OFF"},
		Name:    "socks-proxy-off",
		Usage:   "socks proxy ignored",
		Hidden:  true,
	},
}, logger.GlobalLoggerFlags...)

var OrgFlag = &cli.StringFlag{
	Name:    "organization",
	Aliases: []string{"org"},
	Usage:   "organization id or full name (e.g. 123 or octocat)",
}

var RepoFlag = &cli.StringFlag{
	Name:    "repository",
	Aliases: []string{"repo"},
	Usage:   "repository id or full name (e.g. 134 or octocat/hello-world)",
}

Functions

func After

func After(_ *cli.Context) error

func Before

func Before(c *cli.Context) error

func DetectPipelineConfig

func DetectPipelineConfig() (isDir bool, config string, _ error)

func FormatFlag

func FormatFlag(tmpl string, hidden ...bool) *cli.StringFlag

FormatFlag return format flag with value set based on template if hidden value is set, flag will be hidden.

func OutputFlags

func OutputFlags(def string) []cli.Flag

OutputFlags returns a slice of cli.Flag containing output format options.

func RunPipelineFunc

func RunPipelineFunc(c *cli.Context, fileFunc, dirFunc func(*cli.Context, string) error) error