document

Documentation

Index

• Constants
• func CreateDownloadsTable(w io.Writer, bucket, tars, images, prevTag, newTag string) error
• type Document
  • func GatherReleaseNotesDocument(opts *options.Options, previousRev, currentRev string) (*Document, error)
  • func New(releaseNotes *notes.ReleaseNotes, previousRev, currentRev string) (*Document, error)
  • func (d *Document) RenderMarkdownTemplate(bucket, tars, images, templateSpec string) (string, error)
• type File
• type FileMetadata
• type Image
• type ImageMetadata
• type NoteCategory
• type NoteCollection
  • func (n *NoteCollection) Sort(kindPriority []notes.Kind)

Constants

const ContainerImagesDescription = `` /* 237-byte string literal not displayed */

Functions

func CreateDownloadsTable

func CreateDownloadsTable(w io.Writer, bucket, tars, images, prevTag, newTag string) error

CreateDownloadsTable creates the markdown table with the links to the tarballs. The function does nothing if the `tars` variable is empty.

Types

type Document

type Document struct {
	NotesWithActionRequired notes.Notes    `json:"action_required"`
	Notes                   NoteCollection `json:"notes"`
	FileDownloads           *FileMetadata  `json:"downloads"`
	ImageDownloads          *ImageMetadata `json:"images"`
	CurrentRevision         string         `json:"release_tag"`
	PreviousRevision        string
	CVEList                 []cve.CVE
}

Document represents the underlying structure of a release notes document.

func GatherReleaseNotesDocument

func GatherReleaseNotesDocument(
	opts *options.Options, previousRev, currentRev string,
) (*Document, error)

GatherReleaseNotesDocument creates a new gatherer and collects the release notes into a fresh document.

func New

func New(
	releaseNotes *notes.ReleaseNotes,
	previousRev, currentRev string,
) (*Document, error)

New assembles an organized document from an unorganized set of release notes.

func (*Document) RenderMarkdownTemplate

func (d *Document) RenderMarkdownTemplate(bucket, tars, images, templateSpec string) (string, error)

RenderMarkdownTemplate renders a document using the golang template in `templateSpec`. If `templateSpec` is set to `options.GoTemplateDefault`, then it renders in the default template markdown format.

type File

type File struct {
	Checksum, Name, URL string
}

A File is a downloadable file.

type FileMetadata

type FileMetadata struct {
	// Files containing source code
	Source []File

	// Client binaries
	Client []File

	// Server binaries
	Server []File

	// Node binaries
	Node []File
}

FileMetadata contains metadata about files associated with the release.

type Image

type Image struct {
	Name          string
	Architectures []string
}

Image is a released container image.

type ImageMetadata

type ImageMetadata []Image

ImageMetadata is a list of images.

type NoteCategory

type NoteCategory struct {
	Kind        notes.Kind
	NoteEntries *notes.Notes
}

NoteCategory contains notes of the same `Kind` (i.e category).

type NoteCollection

type NoteCollection []NoteCategory

NoteCollection is a collection of note categories.

func (*NoteCollection) Sort

func (n *NoteCollection) Sort(kindPriority []notes.Kind)

Sort sorts the collection by priority order.