types

Documentation

Index

• Constants
• type ByLabel
  • func (a ByLabel) Len() int
  • func (a ByLabel) Less(i, j int) bool
  • func (a ByLabel) Swap(i, j int)
• type Configuration
• type DisplayLabelOptions
• type IssueSummary
• type LabelDisplayOptionsParser
  • func (c *LabelDisplayOptionsParser) Get() interface{}
  • func (c *LabelDisplayOptionsParser) Set(s string) error
  • func (c *LabelDisplayOptionsParser) SetValue(val interface{})
  • func (c *LabelDisplayOptionsParser) String() string
• type NoOption
• type SliceString
  • func (c *SliceString) Get() interface{}
  • func (c *SliceString) Set(rawValue string) error
  • func (c *SliceString) SetValue(val interface{})
  • func (c *SliceString) String() string
• type Summary

Constants

const (
	DefaultBaseBranch         = "master"
	DefaultEnhancementLabel   = "enhancement"
	DefaultDocumentationLabel = "documentation"
	DefaultBugLabel           = "bug"
	DefaultOutputDestination  = "file"
	DefaultFileName           = "CHANGELOG.md"
)

Default configuration values.

Types

type ByLabel

type ByLabel []IssueSummary

ByLabel sort by label.

func (ByLabel) Len

func (a ByLabel) Len() int

func (ByLabel) Less

func (a ByLabel) Less(i, j int) bool

func (ByLabel) Swap

func (a ByLabel) Swap(i, j int)

type Configuration

type Configuration struct {
	ConfigFile           string               `long:"config-file" description:"A configuration file. [optional]" toml:"-"`
	Owner                string               `short:"o" description:"Repository owner."`
	RepositoryName       string               `long:"repo-name" short:"r" description:"Repository name."`
	GitHubToken          string               `long:"token" short:"t" description:"GitHub Token. [optional]"`
	OutputType           string               `long:"output-type" description:"Output destination type. (file|Stdout)"`
	FileName             string               `long:"file-name" description:"Name of the changelog file."`
	CurrentRef           string               `long:"current-ref" short:"c" description:"Current commit reference. Can be a tag, a branch, a SHA."`
	PreviousRef          string               `long:"previous-ref" short:"p" description:"Previous commit reference. Can be a tag, a branch, a SHA."`
	BaseBranch           string               `long:"base-branch" short:"b" description:"Base branch name. PR branch destination."`
	FutureCurrentRefName string               `long:"future-ref-name" short:"f" description:"The future name of the current reference."`
	ThresholdPreviousRef int                  `long:"th-before" description:"Threshold in seconds after the previous ref date."`
	ThresholdCurrentRef  int                  `long:"th-after" description:"Threshold in seconds after the current ref date."`
	Debug                bool                 `long:"debug" description:"Debug mode."`
	DisplayLabel         bool                 `long:"display-label" description:"Display labels"`
	LabelExcludes        []string             `long:"exclude-label" description:"Label to exclude."`
	LabelEnhancement     string               `long:"enhancement-label" description:"Enhancement Label."`
	LabelDocumentation   string               `long:"doc-label" description:"Documentation Label."`
	LabelBug             string               `long:"bug-label" description:"Bug Label."`
	DisplayLabelOptions  *DisplayLabelOptions `long:"dl-options" description:"Label display options."`
	TemplateFile         string               `long:"tmpl-file" description:"A template file. [optional]"`
}

Configuration GCG Configuration.

type DisplayLabelOptions

type DisplayLabelOptions struct {
	FilteredPrefixes []string `long:"prefix-filter" description:"Included label prefixes."`
	ExcludedPrefixes []string `long:"prefix-exclude" description:"Excluded label prefixes."`
	FilteredSuffixes []string `long:"suffix-filter" description:"Included label suffixes."`
	ExcludedSuffixes []string `long:"suffix-exclude" description:"Excluded label suffixes."`
	TrimmedPrefixes  []string `long:"prefix-trim" description:"Trim label with the following prefixes."`
}

DisplayLabelOptions the options defining the labeling display.

type IssueSummary

type IssueSummary struct {
	FilteredLabelNames string
	Issue              *github.Issue
}

IssueSummary an issue summary.

type LabelDisplayOptionsParser

type LabelDisplayOptionsParser DisplayLabelOptions

LabelDisplayOptionsParser a parser for DisplayLabelOptions.

func (*LabelDisplayOptionsParser) Get

func (c *LabelDisplayOptionsParser) Get() interface{}

Get a DisplayLabelOptions.

func (*LabelDisplayOptionsParser) Set

func (c *LabelDisplayOptionsParser) Set(s string) error

Set a DisplayLabelOptions.

func (*LabelDisplayOptionsParser) SetValue

func (c *LabelDisplayOptionsParser) SetValue(val interface{})

SetValue a DisplayLabelOptions.

func (*LabelDisplayOptionsParser) String

func (c *LabelDisplayOptionsParser) String() string

String a string representation of DisplayLabelOptions.

type NoOption

type NoOption struct{}

NoOption empty struct.

type SliceString

type SliceString []string

SliceString type used for flaeg parsing.

func (*SliceString) Get

func (c *SliceString) Get() interface{}

Get a SliceString.

func (*SliceString) Set

func (c *SliceString) Set(rawValue string) error

Set a SliceString.

func (*SliceString) SetValue

func (c *SliceString) SetValue(val interface{})

SetValue a SliceString.

func (*SliceString) String

func (c *SliceString) String() string

String a string representation of SliceString.

type Summary

type Summary struct {
	CurrentRefName  string
	CurrentRefDate  string
	PreviousRefName string
	Owner           string
	RepositoryName  string
	Enhancement     []IssueSummary
	Documentation   []IssueSummary
	Bug             []IssueSummary
	Other           []IssueSummary
}

Summary a repository summary.