release

Documentation

Index

• Constants
• func DefaultNotesTemplate() string
• func DefaultTemplateFuncs(t *template.Template) *template.Template
• type ComponentData
  • func (cd ComponentData) HasReleaseNotes() bool
• type IssuesQuery
  • func (q IssuesQuery) Exp() (*regexp.Regexp, error)
• type NotesData
  • func FetchNotesData(ctx context.Context, repo *git.Repository, client *github.Client, ...) (NotesData, error)
  • func (notes NotesData) HasComponentReleases() bool
  • func (notes NotesData) WriteVersionNotes() (VersionNote, error)
• type NotesPage
  • func ParseNotesPage(input string) (NotesPage, error)
  • func ParseNotesPageWithExpressionAndReleasesSentinel(input, releaseRegularExpression, releasesSentinel string) (NotesPage, error)
  • func (page *NotesPage) Add(versionNote VersionNote) error
  • func (page *NotesPage) WriteTo(w io.Writer) (int64, error)
• type VersionNote

Constants

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

Functions

func DefaultNotesTemplate

func DefaultNotesTemplate() string

func DefaultTemplateFuncs

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

Types

type ComponentData

type ComponentData struct {
	component.Lock
	Releases []*github.RepositoryRelease
}

func (ComponentData) HasReleaseNotes

func (cd ComponentData) HasReleaseNotes() bool

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   `` /* 328-byte string literal not displayed */
}

func (IssuesQuery) Exp

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

type NotesData

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

	Issues     []*github.Issue
	Components []ComponentData
	Bumps      component.BumpList

	Stemcell cargo.Stemcell
}

func FetchNotesData

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

func (NotesData) HasComponentReleases

func (notes NotesData) HasComponentReleases() bool

func (NotesData) WriteVersionNotes

func (notes NotesData) WriteVersionNotes() (VersionNote, error)

type NotesPage

type NotesPage struct {
	Exp *regexp.Regexp

	Prefix, Suffix string
	Releases       []VersionNote
}

func ParseNotesPage

func ParseNotesPage(input string) (NotesPage, error)

func ParseNotesPageWithExpressionAndReleasesSentinel

func ParseNotesPageWithExpressionAndReleasesSentinel(input, releaseRegularExpression, releasesSentinel string) (NotesPage, error)

func (*NotesPage) Add

func (page *NotesPage) Add(versionNote VersionNote) error

func (*NotesPage) WriteTo

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

type VersionNote

type VersionNote struct {
	Version string
	Notes   string
}