changelog

package
v0.0.0-...-d5788a2 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ReadChangelogAsString

func ReadChangelogAsString(filename string) (string, error)

ReadChangelogAsString reads a file and returns it as a string

Types

type Changelog

type Changelog interface {
	RetrieveChanges()
	GetVersions()
	ConvertToDesiredTag()
	// contains filtered or unexported methods
}

Changelog interface for changelog.md file

type Properties

type Properties struct {
	Changes string
	// contains filtered or unexported fields
}

Properties for changelog

func (*Properties) ConvertToDesiredTag

func (c *Properties) ConvertToDesiredTag() string

ConvertToDesiredTag changes the markdown version line into a version tag, by removing markdown notation and spaces

func (*Properties) GetVersions

func (c *Properties) GetVersions(changelog string)

GetVersions retrieves versions from changelog where lines are formatted as with prefix of ## and numbers

func (*Properties) RetrieveChanges

func (c *Properties) RetrieveChanges(changelog string)

RetrieveChanges gets all the changes from the log file between the desired and previous version lines

func (*Properties) ValidateVersionSemantics

func (c *Properties) ValidateVersionSemantics() bool

ValidateVersionSemantics takes the desired and previous versions and ensures that the desired is larger than previous

Jump to

Keyboard shortcuts

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