rule

Documentation

Overview

Package rule provides functions to handle release rule configuration.

Index

• Constants
• Variables
• type Flag
  • func (f *Flag) Set(value string) error
  • func (f *Flag) String() string
  • func (f *Flag) Type() string
• type Rules
  • func Unmarshall(input map[string][]string) (Rules, error)

Constants

const FlagType = "JSON string"

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 rule found")
)

var Default = Rules{
	Map: map[string]string{
		"feat":   "minor",
		"fix":    "patch",
		"perf":   "patch",
		"revert": "patch",
	},
}

Types

type Flag

type Flag map[string][]string

func (*Flag) Set

func (f *Flag) Set(value string) error

func (*Flag) String

func (f *Flag) String() string

func (*Flag) Type

func (f *Flag) Type() string

type Rules

type Rules struct {
	Map map[string]string
}

func Unmarshall

func Unmarshall(input map[string][]string) (Rules, error)

Unmarshall takes a raw Viper configuration and returns a Rules struct representing release rules configuration.