notes

Documentation

Index

• Constants
• func GenerateTOC(input string) (string, error)
• func HasString(a []string, x string) bool
• func IsActionRequired(pr *github.PullRequest) bool
• func LabelsWithPrefix(pr *github.PullRequest, prefix string) []string
• func NoteTextFromString(s string) (string, error)
• type DocType
• type Document
  • func CreateDocument(notes ReleaseNotes, history ReleaseNotesHistory) (*Document, error)
  • func (d *Document) RenderMarkdown(bucket, tars, prevTag, newTag string) (string, error)
• type Documentation
  • func DocumentationFromString(s string) []*Documentation
• type Gatherer
  • func NewGatherer(ctx context.Context, opts *options.Options) *Gatherer
  • func NewGathererWithClient(ctx context.Context, c client.Client) *Gatherer
  • func (g *Gatherer) ListCommits(branch, start, end string) ([]*github.RepositoryCommit, error)
  • func (g *Gatherer) ListReleaseNotes() (ReleaseNotes, ReleaseNotesHistory, error)
  • func (g *Gatherer) PRsFromCommit(commit *github.RepositoryCommit) ([]*github.PullRequest, error)
  • func (g *Gatherer) ReleaseNoteFromCommit(result *Result, relVer string) (*ReleaseNote, error)
• type ReleaseNote
• type ReleaseNotes
• type ReleaseNotesHistory
• type Result

Constants

const (
	KindAPIChange       = "api-change"
	KindBug             = "bug"
	KindCleanup         = "cleanup"
	KindDeprecation     = "deprecation"
	KindDesign          = "design"
	KindDocumentation   = "documentation"
	KindFailingTest     = "failing-test"
	KindFeature         = "feature"
	KindFlake           = "flake"
	KindBugCleanupFlake = "Other (Bug, Cleanup or Flake)"
)

const (
	DefaultOrg  = "kubernetes"
	DefaultRepo = "kubernetes"
)

Functions

func GenerateTOC

func GenerateTOC(input string) (string, error)

func HasString

func HasString(a []string, x string) bool

func IsActionRequired

func IsActionRequired(pr *github.PullRequest) bool

IsActionRequired indicates whether or not the release-note-action-required label was set on the PR.

func LabelsWithPrefix

func LabelsWithPrefix(pr *github.PullRequest, prefix string) []string

LabelsWithPrefix is a helper for fetching all labels on a PR that start with a given string. This pattern is used often in the k/k repo and we can take advantage of this to contextualize release note generation with the kind, sig, area, etc labels.

func NoteTextFromString

func NoteTextFromString(s string) (string, error)

NoteTextFromString returns the text of the release note given a string which may contain the commit message, the PR description, etc. This is generally the content inside the ```release-note ``` stanza.

Types

type DocType

type DocType string

const (
	DocTypeExternal DocType = "external"
	DocTypeKEP      DocType = "KEP"
	DocTypeOfficial DocType = "official"
)

type Document

type Document struct {
	ActionRequired []string            `json:"action_required"`
	Kinds          map[string][]string `json:"kinds"`
	Uncategorized  []string            `json:"uncategorized"`
}

Document represents the underlying structure of a release notes document.

func CreateDocument

func CreateDocument(notes ReleaseNotes, history ReleaseNotesHistory) (*Document, error)

CreateDocument assembles an organized document from an unorganized set of release notes

func (*Document) RenderMarkdown

func (d *Document) RenderMarkdown(bucket, tars, prevTag, newTag string) (string, error)

RenderMarkdown accepts a Document and writes a version of that document to supplied io.Writer in markdown format.

type Documentation

type Documentation struct {
	// A description about the documentation
	Description string `json:"description,omitempty"`

	// The url to be linked
	URL string `json:"url"`

	// Clssifies the link as something special, like a KEP
	Type DocType `json:"type"`
}

func DocumentationFromString

func DocumentationFromString(s string) []*Documentation

type Gatherer

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

func NewGatherer

func NewGatherer(ctx context.Context, opts *options.Options) *Gatherer

NewGatherer creates a new notes gatherer

func NewGathererWithClient

func NewGathererWithClient(ctx context.Context, c client.Client) *Gatherer

NewGathererWithClient creates a new notes gatherer with a specific client

func (*Gatherer) ListCommits

func (g *Gatherer) ListCommits(branch, start, end string) ([]*github.RepositoryCommit, error)

ListCommits lists all commits starting from a given commit SHA and ending at a given commit SHA.

func (*Gatherer) ListReleaseNotes

func (g *Gatherer) ListReleaseNotes() (ReleaseNotes, ReleaseNotesHistory, error)

ListReleaseNotes produces a list of fully contextualized release notes starting from a given commit SHA and ending at starting a given commit SHA.

func (*Gatherer) PRsFromCommit

func (g *Gatherer) PRsFromCommit(commit *github.RepositoryCommit) (
	[]*github.PullRequest, error,
)

PRsFromCommit return an API Pull Request struct given a commit struct. This is useful for going from a commit log to the PR (which contains useful info such as labels).

func (*Gatherer) ReleaseNoteFromCommit

func (g *Gatherer) ReleaseNoteFromCommit(result *Result, relVer string) (*ReleaseNote, error)

ReleaseNoteFromCommit produces a full contextualized release note given a GitHub commit API resource.

type ReleaseNote

type ReleaseNote struct {
	// Commit is the SHA of the commit which is the source of this note. This is
	// also effectively a unique ID for release notes.
	Commit string `json:"commit"`

	// Text is the actual content of the release note
	Text string `json:"text"`

	// Markdown is the markdown formatted note
	Markdown string `json:"markdown"`

	// Docs is additional documentation for the release note
	Documentation []*Documentation `json:"documentation,omitempty"`

	// Author is the GitHub username of the commit author
	Author string `json:"author"`

	// AuthorURL is the GitHub URL of the commit author
	AuthorURL string `json:"author_url"`

	// PrURL is a URL to the PR
	PrURL string `json:"pr_url"`

	// PrNumber is the number of the PR
	PrNumber int `json:"pr_number"`

	// Areas is a list of the labels beginning with area/
	Areas []string `json:"areas,omitempty"`

	// Kinds is a list of the labels beginning with kind/
	Kinds []string `json:"kinds,omitempty"`

	// SIGs is a list of the labels beginning with sig/
	SIGs []string `json:"sigs,omitempty"`

	// Indicates whether or not a note will appear as a new feature
	Feature bool `json:"feature,omitempty"`

	// Indicates whether or not a note is duplicated across SIGs
	Duplicate bool `json:"duplicate,omitempty"`

	// Indicates whether or not a note is duplicated across Kinds
	DuplicateKind bool `json:"duplicate_kind,omitempty"`

	// ActionRequired indicates whether or not the release-note-action-required
	// label was set on the PR
	ActionRequired bool `json:"action_required,omitempty"`

	// Tags each note with a release version if specified
	// If not specified, omitted
	ReleaseVersion string `json:"release_version,omitempty"`
}

ReleaseNote is the type that represents the total sum of all the information we've gathered about a single release note.

type ReleaseNotes

type ReleaseNotes map[int]*ReleaseNote

ReleaseNotes is a map of PR numbers referencing notes. To avoid needless loops, we need to be able to reference things by PR When we have to merge old and new entries, we want to be able to override the old entries with the new ones efficiently.

type ReleaseNotesHistory

type ReleaseNotesHistory []int

ReleaseNotesHistory is the sorted list of PRs in the commit history

type Result

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