notes

Documentation

Index

• Constants
• func DefaultTemplate() string
• func DefaultTemplateFunctions(t *template.Template) *template.Template
• func IssueTitleRegex() *regexp.Regexp
• func ReleaseExpression() *regexp.Regexp
• func TrainstatURL() string
• type BOSHReleaseData
  • func (cd BOSHReleaseData) HasReleaseNotes() bool
• type Data
  • func FetchData(ctx context.Context, repo *git.Repository, client *github.Client, ...) (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
• type TrainstatClient
  • func NewTrainstatClient(host string) TrainstatClient
  • func (t *TrainstatClient) FetchTrainstatNotes(ctx context.Context, milestone string, version string, tile string) (notes []string, err error)
  • func (t *TrainstatClient) FetchTrainstatWinfsVersionInfo(ctx context.Context, milestone string, version string) (bumped bool, winfsVersion string, err error)
• type TrainstatNotesFetcher
• type TrainstatQuery

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

func TrainstatURL

func TrainstatURL() string

Types

type BOSHReleaseData

type BOSHReleaseData struct {
	cargo.BOSHReleaseTarballLock
	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
	TrainstatNotes []string

	Stemcell cargo.Stemcell
	Window   string
}

func FetchData

func FetchData(ctx context.Context, repo *git.Repository, client *github.Client, tileRepoHost, tileRepoOwner, tileRepoName, kilnfilePath, initialRevision, finalRevision string, issuesQuery IssuesQuery, trainstatClient TrainstatNotesFetcher, variables map[string]any) (Data, error)

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
}

type TrainstatClient

type TrainstatClient struct {
	// contains filtered or unexported fields
}

func NewTrainstatClient

func NewTrainstatClient(host string) TrainstatClient

func (*TrainstatClient) FetchTrainstatNotes

func (t *TrainstatClient) FetchTrainstatNotes(ctx context.Context, milestone string, version string, tile string) (notes []string, err error)

func (*TrainstatClient) FetchTrainstatWinfsVersionInfo

func (t *TrainstatClient) FetchTrainstatWinfsVersionInfo(ctx context.Context, milestone string, version string) (bumped bool, winfsVersion string, err error)

type TrainstatNotesFetcher

type TrainstatNotesFetcher interface {
	FetchTrainstatNotes(ctx context.Context, milestone string, version string, tile string) ([]string, error)
	FetchTrainstatWinfsVersionInfo(ctx context.Context, milestone string, version string) (bool, string, error)
}

type TrainstatQuery

type TrainstatQuery struct {
	TrainstatURL string `` /* 161-byte string literal not displayed */
}