changelog

package

v0.0.0-...-a5ab9a2 Latest Latest Go to latest Published: Feb 11, 2024 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/niclasvaneyk/keepac

Links

Open Source Insights

Documentation ¶

Index ¶

func ChangeTypeLabel(changeType ChangeType) string
func CompleteReleasesAsFirstArgument(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)
func FindChangelogIn(directory string) (string, bool)
func HasChanges(sections *([]Section)) bool
func ResolvePathToChangelog() (string, error)
func Search(changelog *Changelog, query string) string
func Show(contents string) error
type Bounds
- func EmptyBounds() Bounds
type ChangeType
- func KnownChangeTypes() []ChangeType
- func LastChangeType() ChangeType
- func ParseChangeType(name string) ChangeType
type Changelog
- func Parse(source []byte) Changelog
- func ResolveChangelog() (*Changelog, string, error)
- func (changelog *Changelog) AddItem(changeType ChangeType, contents string) string
- func (changelog *Changelog) ContentWithin(bounds *Bounds) string
- func (changelog *Changelog) Diff(from string, to string) (string, error)
- func (changelog *Changelog) DiffLen(other string) int
- func (changelog *Changelog) FindRelease(version string) *Release
- func (changelog *Changelog) Merge(from string, to string, prefixItemsWithVersion bool) (string, error)
- func (changelog *Changelog) ReplacedWithinBounds(bounds Bounds, replacement string) string
- func (changelog *Changelog) Stop() int
- func (changelog *Changelog) WithAddition(insertionPoint int, addition string) string
- func (changelog *Changelog) Yank(version string) (string, error)
type Item
type NewLines
- func (p *NewLines) Join(before string, subject string, after string) string
type NextRelease
- func (next *NextRelease) FindSection(changeType ChangeType) *Section
type Release
- func NewRelease(version string, date string) Release
type Releases
type Section

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ChangeTypeLabel ¶

func ChangeTypeLabel(changeType ChangeType) string

func CompleteReleasesAsFirstArgument ¶

func CompleteReleasesAsFirstArgument(
	cmd *cobra.Command,
	args []string,
	toComplete string,
) ([]string, cobra.ShellCompDirective)

Can be passed as ValidArgsFunction to support custom completions if the first argument is a released version.

func FindChangelogIn ¶

func FindChangelogIn(directory string) (string, bool)

func HasChanges ¶

func HasChanges(sections *([]Section)) bool

func ResolvePathToChangelog ¶

func ResolvePathToChangelog() (string, error)

func Search ¶

func Search(changelog *Changelog, query string) string

func Show ¶

func Show(contents string) error

Types ¶

type Bounds ¶

type Bounds struct {
	Start int
	Stop  int
}

func EmptyBounds ¶

func EmptyBounds() Bounds

type ChangeType ¶

type ChangeType int64

const (
	Added ChangeType = iota
	Changed
	Deprecated
	Fixed
	Removed
	Security
	Unknown
)

func KnownChangeTypes ¶

func KnownChangeTypes() []ChangeType

func LastChangeType ¶

func LastChangeType() ChangeType

func ParseChangeType ¶

func ParseChangeType(name string) ChangeType

type Changelog ¶

type Changelog struct {
	Title    string
	Releases Releases
	// contains filtered or unexported fields
}

func Parse ¶

func Parse(source []byte) Changelog

func ResolveChangelog ¶

func ResolveChangelog() (*Changelog, string, error)

func (*Changelog) AddItem ¶

func (changelog *Changelog) AddItem(changeType ChangeType, contents string) string

func (*Changelog) ContentWithin ¶

func (changelog *Changelog) ContentWithin(bounds *Bounds) string

func (*Changelog) Diff ¶

func (changelog *Changelog) Diff(from string, to string) (string, error)

Shows everything between the two given versions.

func (*Changelog) DiffLen ¶

func (changelog *Changelog) DiffLen(other string) int

func (*Changelog) FindRelease ¶

func (changelog *Changelog) FindRelease(version string) *Release

func (*Changelog) Merge ¶

func (changelog *Changelog) Merge(from string, to string, prefixItemsWithVersion bool) (string, error)

Merges

func (*Changelog) ReplacedWithinBounds ¶

func (changelog *Changelog) ReplacedWithinBounds(bounds Bounds, replacement string) string

func (*Changelog) Stop ¶

func (changelog *Changelog) Stop() int

Returns the end index of the changelog

func (*Changelog) WithAddition ¶

func (changelog *Changelog) WithAddition(insertionPoint int, addition string) string

func (*Changelog) Yank ¶

func (changelog *Changelog) Yank(version string) (string, error)

type Item ¶

type Item struct {
	Bounds Bounds
}

type NewLines ¶

type NewLines struct {
	Before int
	After  int
}

func (*NewLines) Join ¶

func (p *NewLines) Join(before string, subject string, after string) string

type NextRelease ¶

type NextRelease struct {
	HeadlineBounds Bounds
	Bounds         Bounds
	Sections       []Section
}

func (*NextRelease) FindSection ¶

func (next *NextRelease) FindSection(changeType ChangeType) *Section

type Release ¶

type Release struct {
	Sections []Section
	Date     string
	Yanked   bool
	Version  string

	HeadlineBounds Bounds
	Bounds         Bounds
}

func NewRelease ¶

func NewRelease(version string, date string) Release

type Releases ¶

type Releases struct {
	Next *NextRelease
	Past []Release
}

type Section ¶

type Section struct {
	Type   ChangeType
	Items  []Item
	Bounds Bounds
}

Source Files ¶

View all Source files

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