blog

Documentation

Index

• func FormatPR(r io.Reader) ([]byte, error)
• func FormatRelease(author, milestone, changelog string) ([]byte, error)
• func OpenChangelogPullRequest(milestone string) error
• type ChangelogPR
• type Merged
• type Release
  • func LatestRelease() (Release, error)

Functions

func FormatPR

func FormatPR(r io.Reader) ([]byte, error)

FormatPR formats input by replacing pull refs #1234 with markdown links [#1234](...pull/1234)

func FormatRelease

func FormatRelease(author, milestone, changelog string) ([]byte, error)

FormatRelease formats a release template and injects author, milestone, changelog, and merged PR counts

func OpenChangelogPullRequest

func OpenChangelogPullRequest(milestone string) error

OpenChangelogPullRequest attempts to open a browser to the changelog PR of a given milestone

Types

type ChangelogPR

type ChangelogPR struct {
	Items []struct {
		HTMLURL string `json:"html_url"`
	} `json:"items"`
}

ChangelogPR is the API response when searching for the milestone changelog PR

type Merged

type Merged struct {
	TotalCount int `json:"total_count"`
}

Merged is the API response for getting count of merged PRs in a milestone

type Release

type Release struct {
	Name        string    `json:"name"`
	PublishedAt time.Time `json:"published_at"`
}

Release is the API response for a release

func LatestRelease

func LatestRelease() (Release, error)

LatestRelease gets the latest release, used as a default for the generator