release

Documentation

Overview

Package release provides the Release structure.

Index

• type Release
  • func New(repo, markup, version, previousVersion string) (*Release, error)
  • func (r *Release) SetSections(sections []config.Section, fragments []fragment.Fragment)

Types

type Release

type Release struct {
	// Date is the date of the release.
	Date time.Time
	// Header is the markup character used when writing the release header.
	Header string
	// PreviousVersion is the version before this release.
	PreviousVersion string
	// Repository is the URL of the project repository.
	Repository string
	// SectionHeader is the markup character used when writing a section header.
	SectionHeader string
	// Sections is the list of change types in this release.
	Sections []section.Section
	// Version is the version of this release.
	Version string
}

Release represents the data used to generate a release entry in a stentor-managed news file.

func New

func New(repo, markup, version, previousVersion string) (*Release, error)

New returns a Release.

The repo should be a parsable URL.

func (*Release) SetSections

func (r *Release) SetSections(sections []config.Section, fragments []fragment.Fragment)

SetSections populates the release's sections.