notes

Documentation

Index

• Constants
• func DefaultTemplate() string
• func DefaultTemplateFunctions(t *template.Template) *template.Template
• func IssueTitleRegex() *regexp.Regexp
• func ReleaseExpression() *regexp.Regexp
• type BOSHReleaseData
  • func (cd BOSHReleaseData) HasReleaseNotes() bool
• type Data
  • func FetchData(ctx context.Context, repo *git.Repository, client *github.Client, ...) (Data, error)
  • func FetchDataWithoutRepo(ctx context.Context, client *github.Client, tileRepoOwner, tileRepoName string, ...) (Data, error)
  • func (notes Data) HasComponentReleases() bool
  • func (notes Data) WriteVersionNotes() (TileRelease, error)
• type IssuesQuery
  • func (q IssuesQuery) Exp() (*regexp.Regexp, error)
• type Page
  • func ParsePage(input string) (Page, error)
  • func ParsePageWithExpressionAndReleasesSentinel(input, releaseRegularExpression, releasesSentinel string) (Page, error)
  • func (page *Page) Add(versionNote TileRelease) error
  • func (page *Page) WriteTo(w io.Writer) (int64, error)
• type TileRelease

Constants

const DefaultReleasesSentinel = "\n## <a id='releases'></a> Releases\n\n"

Functions

func DefaultTemplate

func DefaultTemplate() string

func DefaultTemplateFunctions

func DefaultTemplateFunctions(t *template.Template) *template.Template

func IssueTitleRegex

func IssueTitleRegex() *regexp.Regexp

func ReleaseExpression

func ReleaseExpression() *regexp.Regexp

Types

type BOSHReleaseData

type BOSHReleaseData struct {
	cargo.ComponentLock
	Releases []*github.RepositoryRelease
}

func (BOSHReleaseData) HasReleaseNotes

func (cd BOSHReleaseData) HasReleaseNotes() bool

type Data

type Data struct {
	Version     *semver.Version
	ReleaseDate time.Time

	Issues     []*github.Issue
	Components []BOSHReleaseData
	Bumps      cargo.BumpList

	Stemcell cargo.Stemcell
}

func FetchData

func FetchData(ctx context.Context, repo *git.Repository, client *github.Client, tileRepoOwner, tileRepoName, kilnfilePath, initialRevision, finalRevision string, issuesQuery IssuesQuery) (Data, error)

func FetchDataWithoutRepo

func FetchDataWithoutRepo(ctx context.Context, client *github.Client, tileRepoOwner, tileRepoName string, kilnfile cargo.Kilnfile, kilnfileLockInitial, kilnfileLockFinal cargo.KilnfileLock, issuesQuery IssuesQuery) (Data, error)

FetchDataWithoutRepo can be used to generate release notes from tile metadata

func (Data) HasComponentReleases

func (notes Data) HasComponentReleases() bool

func (Data) WriteVersionNotes

func (notes Data) WriteVersionNotes() (TileRelease, error)

type IssuesQuery

type IssuesQuery struct {
	IssueIDs       []string `` /* 149-byte string literal not displayed */
	IssueMilestone string   `` /* 130-byte string literal not displayed */
	IssueLabels    []string `long:"github-issue-label"     short:"l" description:"issue labels to add to issues query"`
	IssueTitleExp  string   `` /* 338-byte string literal not displayed */
}

func (IssuesQuery) Exp

func (q IssuesQuery) Exp() (*regexp.Regexp, error)

type Page

type Page struct {
	Exp *regexp.Regexp

	Prefix, Suffix string
	Releases       []TileRelease
}

func ParsePage

func ParsePage(input string) (Page, error)

func ParsePageWithExpressionAndReleasesSentinel

func ParsePageWithExpressionAndReleasesSentinel(input, releaseRegularExpression, releasesSentinel string) (Page, error)

func (*Page) Add

func (page *Page) Add(versionNote TileRelease) error

func (*Page) WriteTo

func (page *Page) WriteTo(w io.Writer) (int64, error)

type TileRelease

type TileRelease struct {
	Version string
	Notes   string
}