issues

Documentation

Overview

Package issues deals with munging of github issues

Index

• func InitializeMungers(requestedMungers []string, config *github_util.Config) error
• func MungeIssues(config *github_util.Config) error
• func RegisterMunger(munger IssueMunger) error
• type IssueMunger
  • func GetAllMungers() []IssueMunger

Functions

func InitializeMungers

func InitializeMungers(requestedMungers []string, config *github_util.Config) error

InitializeMungers will call munger.Initialize() for all mungers requested in --issue-mungers

func MungeIssues

func MungeIssues(config *github_util.Config) error

MungeIssues is the main function which asks that each munger be called for each Issue

func RegisterMunger

func RegisterMunger(munger IssueMunger) error

RegisterMunger should be called in `init()` by each munger to make itself available by name

Types

type IssueMunger

type IssueMunger interface {
	MungeIssue(config *github_util.Config, issue *github_api.Issue)
	AddFlags(cmd *cobra.Command, config *github_util.Config)
	Initialize(*github_util.Config) error
	Name() string
}

IssueMunger is the interface which all mungers must implement to register

func GetAllMungers

func GetAllMungers() []IssueMunger

GetAllMungers returns a slice of all registered mungers. This list is completely independant of the mungers selected at runtime in --pr-mungers. This is all possible mungers.