service

Documentation

Index

• func CleanTitle(s string) string
• type Contributor
• type ContributorList
  • func (cl ContributorList) Len() int
  • func (cl ContributorList) Less(i, j int) bool
  • func (cl ContributorList) Swap(i, j int)
• type Entry
• type GitHub
  • func (gh *GitHub) Contributors() (ContributorList, error)
  • func (gh *GitHub) Generate() (string, []Entry, error)
• type Gitea
  • func (ge *Gitea) Contributors() (ContributorList, error)
  • func (ge *Gitea) Generate() (string, []Entry, error)
• type Label
• type Service
  • func New(serviceType, repo, baseURL, milestone, tag, token string, issues bool) (Service, error)

Functions

func CleanTitle

func CleanTitle(s string) string

CleanTitle returns the string with spaces trimmed and the first rune title-cased

Types

type Contributor

type Contributor struct {
	Name    string
	Profile string
}

Contributor is a project contributor

type ContributorList

type ContributorList []Contributor

ContributorList is a slice of Contributors that can be sorted

func (ContributorList) Len

func (cl ContributorList) Len() int

Len is the length of the ContributorList

func (ContributorList) Less

func (cl ContributorList) Less(i, j int) bool

Less determines whether a Contributor comes before another Contributor

func (ContributorList) Swap

func (cl ContributorList) Swap(i, j int)

Swap swaps Contributors in a ContributorList

type Entry

type Entry struct {
	Title  string
	Index  int64
	Labels []Label
}

Entry is the minimum information needed to make a changelog entry

type GitHub

type GitHub struct {
	Milestone string
	GitTag    string
	Token     string
	Repo      string
	Issues    bool
}

GitHub defines a GitHub service

func (*GitHub) Contributors

func (gh *GitHub) Contributors() (ContributorList, error)

Contributors returns a list of contributors from GitHub

func (*GitHub) Generate

func (gh *GitHub) Generate() (string, []Entry, error)

Generate returns a GitHub changelog

type Gitea

type Gitea struct {
	Milestone string
	GitTag    string
	Token     string
	BaseURL   string
	Owner     string
	Repo      string
	Issues    bool
}

Gitea defines a Gitea service

func (*Gitea) Contributors

func (ge *Gitea) Contributors() (ContributorList, error)

Contributors returns a list of contributors from Gitea

func (*Gitea) Generate

func (ge *Gitea) Generate() (string, []Entry, error)

Generate returns a Gitea changelog

type Label

type Label struct {
	Name string
}

Label is the minimum information needed for a PR label

type Service

type Service interface {
	Generate() (string, []Entry, error)
	Contributors() (ContributorList, error)
}

Service defines how a struct can be a Changelog Service

func New

func New(serviceType, repo, baseURL, milestone, tag, token string, issues bool) (Service, error)

New returns a service from a string