notes

package
v0.93.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2024 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

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

Variables

This section is empty.

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 added in v0.80.0

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, tileRepoOwner, tileRepoName, kilnfilePath, initialRevision, finalRevision string, issuesQuery IssuesQuery, trainstatClient TrainstatNotesFetcher) (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
}

type TrainstatClient added in v0.80.0

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

func NewTrainstatClient added in v0.80.0

func NewTrainstatClient(host string) TrainstatClient

func (*TrainstatClient) FetchTrainstatNotes added in v0.80.0

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

func (*TrainstatClient) FetchTrainstatWinfsVersionInfo added in v0.89.0

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

type TrainstatNotesFetcher added in v0.80.0

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 added in v0.80.0

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

Directories

Path Synopsis
internal
fakes
Code generated by counterfeiter.
Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL