cmd

Documentation

Index

• Variables
• func ChangeLog(username, project string) error
• func Execute()
• func GetIssueType(issue *github.Issue) string
• func GetToken() (string, error)
• type ChangeTag
  • func GetTags() ([]*ChangeTag, error)

Variables

var RootCmd = &cobra.Command{
	Use:   "bowie",
	Short: "Bowie is a pretty changelog generator",
	Long: `A pretty changelog generator,
built with love by mattstratton in Go.
	
Complete documentation is available at https://github.com/mattstratton/bowie`,

	Run: func(cmd *cobra.Command, args []string) {
		ChangeLog(userName, projectName)
	},
}

RootCmd is the main command executed when bowie is run

Functions

func ChangeLog

func ChangeLog(username, project string) error

ChangeLog generates the changelog with the given flags/configuration

func Execute

func Execute()

Execute is the main root command of bowie

func GetIssueType

func GetIssueType(issue *github.Issue) string

GetIssueType is a utility function to obtain the type of issue (enhancement, bug, or other)

func GetToken

func GetToken() (string, error)

GetToken returns the GitHub token based on environment variable or flag (flag takes precedence)

Types

type ChangeTag

type ChangeTag struct {
	Name         string
	Date         time.Time
	RefURL       string
	Enhancements []*github.Issue
	Bugs         []*github.Issue
	ClosedIssues []*github.Issue
}

ChangeTag is a git tag type, which includes all of the associated issues, etc

func GetTags

func GetTags() ([]*ChangeTag, error)

GetTags gets the list of all tags for the username and project, and returns a map of them