charlie

package module

v0.0.0-...-d72b88c Latest Latest Go to latest Published: Feb 2, 2019 License: MIT Imports: 4 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/mono83/charlie

Links

Open Source Insights

README ¶

Charlie

Charlie is open-source changelog aggregator. Feel free to contribute.

To run project execute

docker-compose build && docker-compose up -d

To perform separate steps (e.g. build, test) run Makefile commands like

make test

Documentation ¶

Index ¶

func SortByVersion(releases []Release)
func SortByVersionDesc(releases []Release)
type Issue
type Release
- func (r Release) SummaryType() map[Type]int
type Type
- func (t Type) String() string
type Version

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func SortByVersion ¶

func SortByVersion(releases []Release)

SortByVersion sorts provided slice of releases (by reference) in ascending order by version

func SortByVersionDesc ¶

func SortByVersionDesc(releases []Release)

SortByVersionDesc sorts provided slice of releases (by reference) in descending order by version

Types ¶

type Issue ¶

type Issue struct {
	ID         string
	Type       Type
	Components []string
	Message    string
}

Issue describes an issue, resolved or implemented in release

type Release ¶

type Release struct {
	Version
	Issues []Issue
	Date   time.Time
}

Release describes whole release data - the name itself, release date and issues

func (Release) SummaryType ¶

func (r Release) SummaryType() map[Type]int

SummaryType returns count issues by type

type Type ¶

type Type byte

Type describes issue type

const (
	Info        Type = 0
	Added       Type = 1
	Changed     Type = 2
	Deprecated  Type = 3
	Removed     Type = 4
	Fixed       Type = 5
	Security    Type = 6
	Performance Type = 7
	Unreleased  Type = 127
)

List of defined issue types

func (Type) String ¶

func (t Type) String() string

String returns string representation of issue type

type Version ¶

type Version struct {
	Major string
	Minor string
	Patch string
	Label string
	Build string
}

Version describes only release version

func (Version) Compare ¶

func (v Version) Compare(other Version) int

Compare method compares two versions This method, used in sorting, will sort version in ascending order

func (Version) Contains ¶

func (v Version) Contains(other Version) bool

Contains methods returns true, if current release version can contain provided one. For example 5.2 can contain 5.2.1 and 5.2.12, but cannot contain 5.3 and 6.0

func (Version) IsStable ¶

func (v Version) IsStable() bool

IsStable returns true if version not contains beta or other not stable flags

func (Version) String ¶

func (v Version) String() string

String returns string representation of version

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
charlie
cmd
config
ini
drivers
http
parse
date
markdown
parsers
semantic
process
runner

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