rules

Documentation

Overview

Package rules provides functions to deal with release rules.

Index

• Constants
• Variables
• type Options
• type ReleaseRule
• type ReleaseRules
  • func Init(opts *Options) (rr *ReleaseRules, err error)
  • func Parse(reader io.Reader) (*ReleaseRules, error)
  • func (r *ReleaseRules) Map() map[string]string

Constants

const Default = `` /* 178-byte string literal not displayed */

Variables

var (
	ErrInvalidCommitType    = errors.New("invalid commit type")
	ErrInvalidReleaseType   = errors.New("invalid release type")
	ErrDuplicateReleaseRule = errors.New("duplicate release rule for the same commit type")
	ErrNoRules              = errors.New("no rules found")
)

Types

type Options

type Options struct {
	Reader io.Reader
}

type ReleaseRule

type ReleaseRule struct {
	CommitType  string `json:"type"`
	ReleaseType string `json:"release"`
}

type ReleaseRules

type ReleaseRules struct {
	Rules []ReleaseRule `json:"rules"`
}

func Init

func Init(opts *Options) (rr *ReleaseRules, err error)

Init initalize a new set of release rules with the given options if any.

func Parse

func Parse(reader io.Reader) (*ReleaseRules, error)

Parse reads a buffer a returns the corresponding release rules.

func (*ReleaseRules) Map

func (r *ReleaseRules) Map() map[string]string

Map returns a flat map corresponding to the release rules with commit types as keys and release types as values.