service package - code.gitea.io/changelog/service

Documentation ¶

This section is empty.

This section is empty.

func CleanTitle(s string) string

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

type Contributor struct {
	Name    string
	Profile string
}

Contributor is a project contributor

type ContributorList []Contributor

ContributorList is a slice of Contributors that can be sorted

func (cl ContributorList) Len() int

Len is the length of the ContributorList

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

Less determines whether a Contributor comes before another Contributor

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

Swap swaps Contributors in a ContributorList

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

Entry is the minimum information needed to make a changelog entry

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

GitHub defines a GitHub service

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

Contributors returns a list of contributors from GitHub

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

Generate returns a GitHub changelog

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

Gitea defines a Gitea service

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

Contributors returns a list of contributors from Gitea

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

Generate returns a Gitea changelog

type Label struct {
	Name string
}

Label is the minimum information needed for a PR label

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

Service defines how a struct can be a Changelog Service

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

New returns a service from a string