changelog

package

v0.0.0-...-e826043 Latest Latest Go to latest Published: Apr 28, 2022 License: BSD-3-Clause Imports: 7 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

This section is empty.

This section is empty.

func ToFeed(link string, entries []Entry) (*feeds.Feed, error)

ToFeed produces a github.com/gorilla/feeds.Feed that can be written to Atom or Rss

type Entry struct {
	Date    time.Time
	Comment string
	Updates []Update
}

Entry is an section of updates (or release comments) in a ChangeLog.txt

func Parse(r io.Reader) ([]Entry, error)

Parse takes in a slackware ChangeLog.txt and returns its collections of Entries

func (e Entry) SecurityFix() bool

SecurityFix is whether an update in this ChangeLog Entry includes a SecurityFix

func (e Entry) ToChangeLog() string

ToChangeLog reformats the struct as the text for ChangeLog.txt output

func (e Entry) ToHTML() string

ToHTML reformats the struct as the text for HTML output

type Update struct {
	Name    string
	Action  string
	Comment string
}

Update is a package or component that is updated in a ChangeLog Entry

func (u Update) SecurityFix() bool

SecurityFix that this update is a security fix (that the comment includes `(* Security fix *)`)

func (u Update) ToChangeLog() string

ToChangeLog reformats the struct as the text for ChangeLog.txt output