cmd

Documentation

Index

• Variables
• func Execute()
• type Config
• type Defaults
• type FileType
• type GerritConfig
• type GithubConfig
• type JiraConfig
• type ReviewTool
  • func (r ReviewTool) Normalize() ReviewTool

Variables

var RootCmd = &cobra.Command{
	Use:     "beer",
	Version: version,
	Short:   "CLI for managing your JIRA / Gerrit / git workflow.",
	Long: `Beer Review is a CLI for managing your JIRA <--> Gerrit workflow.

It can be used to create new tickets, work on existing ones, and submit reviews.

For example:
	$ beer brew ABC-123

	This will branch from the current HEAD and set the branch name to ABC-123 and add
	an empty commit with the JIRA ID and JIRA summary text as the first line of
	the commit message.`,
}

RootCmd represents the base command when called without any subcommands

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type Config

type Config struct {
	Jira       JiraConfig
	Gerrit     GerritConfig
	GitHub     GithubConfig
	ReviewTool ReviewTool
}

type Defaults

type Defaults struct {
	Branch     string
	ReviewTool ReviewTool
}

type FileType

type FileType struct {
	Name      string
	Extension string
}

type GerritConfig

type GerritConfig struct {
	URL string
}

GerritConfig configuration structure for gerrit

type GithubConfig

type GithubConfig struct {
}

type JiraConfig

type JiraConfig struct {
	URL      string
	Username string
	Password string
}

JiraConfig configuration structure for JIRA

type ReviewTool

type ReviewTool string

const (
	Gerrit ReviewTool = "gerrit"
	GitHub ReviewTool = "github"
)

func (ReviewTool) Normalize

func (r ReviewTool) Normalize() ReviewTool